diff --git a/.dprint.jsonc b/.dprint.jsonc index 28ff356cfaad108..c33d0ed2898e28c 100644 --- a/.dprint.jsonc +++ b/.dprint.jsonc @@ -38,21 +38,16 @@ "./types/**/*.md" ], - "prettier": { - "associations": [ - "**/*.{yaml,yml}" - ], - "yml.tabWidth": 2, - "yaml.tabWidth": 2, - "yml.singleQuote": true, - "yaml.singleQuote": true + "yaml": { + "indentWidth": 2, + "quotes": "preferSingle" }, // NOTE: if extending this list, also update settings.template.json. "plugins": [ - "https://plugins.dprint.dev/typescript-0.91.4.wasm", - "https://plugins.dprint.dev/json-0.19.3.wasm", - "https://plugins.dprint.dev/markdown-0.17.1.wasm", - "https://plugins.dprint.dev/prettier-0.40.0.json@68c668863ec834d4be0f6f5ccaab415df75336a992aceb7eeeb14fdf096a9e9c" + "https://plugins.dprint.dev/typescript-0.93.3.wasm", + "https://plugins.dprint.dev/json-0.19.4.wasm", + "https://plugins.dprint.dev/markdown-0.17.8.wasm", + "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.0.wasm" ], "indentWidth": 4, "lineWidth": 120, diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index c6278c37f0a695d..1dda9f490a11430 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -92,7 +92,6 @@ /types/ag-simple-broker/v4/ @DanielRose /types/ag-simple-broker/v5/ @DanielRose @Methuselah96 /types/agadoo/ @ArtemKlyuev -/types/agent-base/ @Shinigami92 /types/agiledigital__mule-preview/ @NoxHarmonium /types/agnostic-http-error-handler/ @sPaCeMoNk3yIam /types/ahocorasick/ @Longqin88888 @@ -353,6 +352,7 @@ /types/assertsharp/ @brunolm /types/assets-webpack-plugin/ @kryops /types/async/ @borisyankov @kern0 @fenying @pascalmartin @erossignon @Juliiii @brendtumi @apnsngr +/types/async-alpine/ @bastienrobert /types/async-busboy/ @hirochachacha @bendingbender /types/async-cache/ @BendingBender /types/async-csv/ @Radiergummi @@ -511,6 +511,7 @@ /types/basicauth-middleware/ @nchaulet /types/basiclightbox/ @adrianhopebailie /types/basicscroll/ @peterblazejewicz +/types/basil.js/ @yujiosaka /types/batch-stream/ @drudge /types/battery-level/ @BendingBender /types/bayes-classifier/ @jasonharrison @@ -723,7 +724,7 @@ /types/bull-arena/ @levibostian @gtpan77 /types/bumblebee-hotword/ @sheunglaili /types/bump-regex/ @silkentrance -/types/bun/ @colinhacks @Jarred-Sumner @electroid @paperdave @robobun @dylan-conway +/types/bun/ @Jarred-Sumner @electroid @paperclover @robobun @dylan-conway @nektro @RiskyMH /types/bundle-id/ @LeoDog896 /types/bundle-name/ @LeoDog896 /types/bunnymq/ @cyrilschumacher @@ -857,7 +858,6 @@ /types/changelog-parser/ @osteele /types/channel-io/ @ryota-ka /types/charcodes/ @dylanarmstrong -/types/chardet/ @Gebatzens @samhinshaw /types/charm/ @Xananax /types/charset/ @cspotcode /types/charset-detector/ @OpportunityLiu @@ -1092,7 +1092,6 @@ /types/console-ui/ @dfreeman /types/consolidate/ @soywiz @theosherry @nicolashenry @AndrewLeedham /types/consolidated-events/ @romellem -/types/consul/ @chrootsu @vadim-v @smoke /types/consumable-stream/ @DanielRose @Methuselah96 /types/consumable-stream/v1/ @DanielRose /types/consumable-stream/v2/ @DanielRose @Methuselah96 @@ -1147,7 +1146,7 @@ /types/cordova-plugin-ms-adal/ @KaiWalter /types/cordova-plugin-native-keyboard/ @lobo87 /types/cordova-plugin-ouralabs/ @Justin-Credible -/types/cordova-plugin-qrscanner/ @bitjson @jab +/types/cordova-plugin-qrscanner/ @bitjson /types/cordova-plugin-safariviewcontroller/ @bendingbender /types/cordova-plugin-save-dialog/ @dodomorandi /types/cordova-plugin-spinner/ @Justin-Credible @@ -1269,7 +1268,7 @@ /types/cypress-image-snapshot/ @Keysox /types/cypress__code-coverage/ @k-yle /types/cyrb53/ @igrek8 -/types/cytoscape/ @phreed @wy193777 @ypconstante @janniclas @gsbelarus @peterjferrarotto @spaxe @Veckodag @jsve +/types/cytoscape/ @phreed @ypconstante @janniclas @gsbelarus @peterjferrarotto @spaxe @Veckodag @jsve /types/cytoscape-avsdf/ @rogerdubbs /types/cytoscape-canvas/ @hellomusa /types/cytoscape-context-menus/ @hellomusa @@ -1610,7 +1609,6 @@ /types/dom-webcodecs/ @dogben /types/dom4/ @adidahiya @giladgray /types/domexception/ @ExE-Boss -/types/domhandler/ @johandavidson /types/domo/ @Steve-Fenton /types/domready/ @dotnetnerd /types/domtagger/ @ExE-Boss @@ -1711,7 +1709,6 @@ /types/ebml/ @AppLover69 /types/eccrypto/ @randomnerd /types/ecef-projector/ @BendingBender -/types/echarts/ @xieisabug @AntiMoron @liveangela @Ovilia @iRON5 @bilalucar @tmtron @dwhitney @ruixuel @trajnisz @hiyangguo /types/ecma-proposal-math-extensions/ @ksm2 /types/ecore/ @michael-whi /types/ecurve/ @mhegazy @@ -1849,7 +1846,6 @@ /types/end-of-stream/ @strax /types/engine-check/ @jgeth /types/engine.io/ @KentarouTakeda -/types/engine.io-client/ @KentarouTakeda /types/enigma.js/ @konne /types/enquire.js/ @screendriver /types/ent/ @rogierschouten @@ -1883,8 +1879,6 @@ /types/es-aggregate-error/ @AverageHelper /types/es-feature-detection/ @Jack-Works /types/es-get-iterator/ @JasonHK @ljharb -/types/es-to-primitive/ @ExE-Boss @ljharb -/types/es-value-fixtures/ @ljharb /types/es6-collections/ @rbuckton /types/es6-promisify/ @bschlenk /types/es6-set-proptypes/ @zozoens31 @@ -1939,7 +1933,6 @@ /types/ethereumjs-abi/ @LogvinovLeon @quezak /types/etherport-client/ @ScreamZ /types/ethjs-signer/ @doppio -/types/euclidean-rhythms/ @tom-stringer /types/eureka-js-client/ @karl-run @tombarton @jpsullivan /types/evaluatex/ @forabi-cosuno /types/evaporate/ @kookster @@ -2041,6 +2034,7 @@ /types/express-sitemap-xml/ @ffflorian @peterblazejewicz /types/express-slow-down/ @jdforsythe @joshhendo /types/express-socket.io-session/ @AylaJK +/types/express-sse/ @powerleks /types/express-sslify/ @bengry /types/express-status-monitor/ @alexanderson1993 @tecxar-prashant /types/express-to-koa/ @xiaohanzhang @@ -2056,7 +2050,6 @@ /types/extensible-duck/ @nossbigg /types/extjs/ @brian428 /types/extra-watch-webpack-plugin/ @davecardwell -/types/extract-colors/ @punctuations /types/extract-domain/ @peterblazejewicz /types/extract-files/ @Slessi @lynxtaa /types/extract-text-webpack-plugin/ @flying-sheep @katyo @@ -2880,7 +2873,6 @@ /types/get-res/ @satyarohith /types/get-size/ @leonsilicon /types/get-ssl-certificate/ @peterblazejewicz -/types/get-symbol-description/ @LeoDog896 /types/get-value/ @DanielRosenwasser /types/getenv/ @impankratov /types/getos/ @BendingBender @@ -2981,7 +2973,6 @@ /types/google-images/ @dolanmiu /types/google-libphonenumber/ @leonyu @winfinit /types/google-map-react/ @honzabrecka @romain-faust -/types/google-maps/ @DeividasBakanas @GiedriusGrabauskas /types/google-one-tap/ @voidpumpkin @kostasmanionis @cmgt /types/google-polyline/ @Babettestam /types/google-protobuf/ @marcuslongmuir @kamthamc @@ -2997,6 +2988,7 @@ /types/google.script.client-side/ @clomie /types/google.visualization/ @danludwig @gmoore-sjcorg @danmana @mlcheng @IvanBisultanov @glebm @shrujalshah28 @dckorben @martin-badin /types/google__maps/ @indrimuska +/types/google_interactive_media_ads_types/ @Kiro705 @gschoppe /types/googlefc/ @johngeorgewright /types/googlemaps.infobubble/ @Dashue /types/googlepay/ @Fluccioni @Radu-Raicea @fstanis @mumpo @socsieng @JlUgia @dmengelt @@ -3187,7 +3179,6 @@ /types/hapi__call/ @saboya @nokel81 /types/hapi__catbox/ @jasonswearingen @AJamesPhillips @saboya @lenovouser /types/hapi__catbox-memcached/ @btmorex -/types/hapi__catbox-memory/ @SimonSchick @lenovouser /types/hapi__catbox-redis/ @SimonSchick @lenovouser /types/hapi__content/ @nokel81 /types/hapi__cookie/ @lenovouser @SimonSchick @@ -3202,8 +3193,6 @@ /types/hapi__shot/ @AJamesPhillips @SimonSchick @lenovouser /types/hapi__sntp/ @lenovouser /types/hapi__subtext/ @nokel81 -/types/hapi__vision/ @jasonswearingen @AJamesPhillips @lenovouser -/types/hapi__yar/ @SimonSchick @lenovouser /types/hapipal__avocat/ @timcosta /types/hapipal__schmervice/ @timcosta @damusix /types/hapipal__toys/ @timcosta @@ -3218,11 +3207,9 @@ /types/harmony-proxy/ @remojansen /types/has/ @ljharb @ExE-Boss /types/has-ansi/ @BendingBender -/types/has-bigints/ @BendingBender /types/has-package-exports/ @ljharb @ExE-Boss /types/has-package-self-reference/ @ljharb @ExE-Boss /types/has-property-descriptors/ @ljharb -/types/has-symbols/ @ljharb @ExE-Boss /types/has-values/ @Ankan002 /types/hasbin/ @michastreppel /types/hash-chain/ @BendingBender @@ -3243,7 +3230,6 @@ /types/hawk/ @ffflorian /types/haxball-headless-browser/ @jakjus /types/hbs/ @davidm77 -/types/hcaptcha__react-hcaptcha/ @msutkowski /types/hcaptcha__vue-hcaptcha/ @geopic /types/hdkey/ @LogvinovLeon @TvrtkoM @JAlbertoGonzalez /types/he/ @sedwards2009 @lokidokicoki @@ -3267,9 +3253,7 @@ /types/hex-to-binary/ @geunheejung /types/hex-to-uuid/ @pmqueiroz /types/hex2dec/ @Addono -/types/hexo/ @kentarouTakeda /types/hexo-bunyan/ @segayuu -/types/hexo-fs/ @segayuu /types/hexo-log/ @segayuu /types/hexo-util/ @segayuu @KentarouTakeda /types/hh-mm-ss/ @TotomInc @@ -3304,7 +3288,7 @@ /types/hosted-git-info/ @OiyouYeahYou @Ovyerus @djcsdy /types/hostile/ @AndrewLeedham /types/hot-formula-parser/ @joao-mbn -/types/hotwired__turbo/ @G-Rath @lukeify +/types/hotwired__turbo/ @G-Rath @lukeify @myabc /types/howler/ @xperiments @alien35 @nicholashza @cjurango @MrGriefs /types/hoxy/ @TrueLecter /types/hpp/ @kryops @@ -3325,6 +3309,7 @@ /types/html-replace-webpack-plugin/ @bricka /types/html-tableify/ @inglec-arista /types/html-tag/ @arnu515 +/types/html-to-docx/ @DefinitelyTyped /types/html-to-draftjs/ @1cheese /types/html-to-pdfmake/ @me @cwoebker /types/html-to-rtf/ @bricka @@ -3389,8 +3374,6 @@ /types/i18n/ @SomaticIT @FindQ @martin-badin /types/i18n-abide/ @smbell /types/i18n-iso-countries-regions/ @haykelmahfoudhi -/types/i18n-js/ @ypresto -/types/i18next-fs-backend/ @quantumlyy @favna /types/i18next-node-fs-backend/ @cyrilschumacher @lenovouser /types/i18next-sprintf-postprocessor/ @cyrilschumacher /types/i2c-bus/ @101100 @kou029w @@ -3414,7 +3397,7 @@ /types/idyll-compiler/ @iocat /types/idyll-document/ @iocat /types/iferr/ @segayuu -/types/iframe-resizer/ @arminbaljic +/types/iframe-resizer/ @arminbaljic @xemlock /types/ifvisible/ @maxbogus /types/igdb-api-node/ @susam-projects /types/ignite-ui/ @IgniteUI @@ -3505,7 +3488,6 @@ /types/intercept-stdout/ @pdcastro /types/intercom-web/ @fongandrew @salbahra @onatm /types/intercomjs/ @spencerwi -/types/internal-slot/ @ExE-Boss @ljharb /types/interpret/ @BendingBender /types/intersect/ @ncovercash /types/intersects/ @voxylu @@ -3541,13 +3523,9 @@ /types/iron/ @simonschick @rafaelsouzaf /types/is/ @cabralRodrigo @gricey432 /types/is-absolute/ @BendingBender -/types/is-arguments/ @ljharb @ExE-Boss /types/is-array/ @pine -/types/is-async-function/ @leonsilicon /types/is-base64/ @thewilkybarkid -/types/is-bigint/ @aaronleopold /types/is-blank/ @heygambo -/types/is-boolean-object/ @aaronleopold /types/is-buffer/ @rokt33r /types/is-callable/ @nieltg /types/is-charging/ @BendingBender @@ -3555,7 +3533,6 @@ /types/is-color/ @VitorLuizC /types/is-core-module/ @peterblazejewicz /types/is-data-descriptor/ @Richienb -/types/is-date-object/ @ljharb /types/is-dom/ @peterblazejewicz /types/is-domain-name/ @BendingBender /types/is-dotdir/ @BendingBender @@ -3572,7 +3549,6 @@ /types/is-firefox/ @e9x /types/is-function/ @evangeloszotos /types/is-generator/ @Richienb -/types/is-generator-function/ @Richienb @ljharb /types/is-gif/ @peterblazejewicz /types/is-git-clean/ @MichaelDeBoey /types/is-git-url/ @BendingBender @@ -3586,7 +3562,6 @@ /types/is-iterable/ @BendingBender /types/is-lambda/ @BendingBender /types/is-negated-glob/ @ajafff -/types/is-negative-zero/ @LeoDog896 /types/is-number/ @jedster1111 /types/is-number-like/ @ffflorian /types/is-object/ @wbhob @ljharb @phuctm97 @@ -3594,7 +3569,6 @@ /types/is-posix-bracket/ @LeoDog896 /types/is-potential-custom-element-name/ @1natsu172 /types/is-pr/ @BendingBender -/types/is-regex/ @ljharb @ExE-Boss /types/is-relative/ @BendingBender /types/is-relative-path/ @peterblazejewicz /types/is-running/ @danwbyrne @@ -3602,7 +3576,6 @@ /types/is-semver/ @BendingBender /types/is-ssh/ @ffflorian /types/is-string/ @aaronleopold -/types/is-symbol/ @BendingBender /types/is-touch-device/ @screendriver /types/is-trademarked/ @BendingBender /types/is-typedarray/ @BendingBender @@ -3615,10 +3588,9 @@ /types/is-valid-glob/ @BendingBender /types/is-valid-path/ @Goldsmith42 /types/is-valid-zipcode/ @dmmulroy -/types/is-weakref/ @LeoDog896 /types/is-windows/ @mizunashi-mana @ExE-Boss /types/isaac/ @mo -/types/isarray/ @claasahl +/types/isarray/ @claasahl @ljharb /types/isbn-utils/ @elhaard /types/iscroll/ @csrakowski @devlato /types/iscroll/v4/ @borisyankov @csrakowski @@ -3694,7 +3666,6 @@ /types/jconv/ @thany /types/jdataview/ @RReverser /types/jest/ @NoHomey @jwbay @asvetliakov @alexjoverm @epicallan @ikatyang @wsmd @JamieMason @douglasduteil @ahnpnl @UselessPickles @r3nya @hotell @sebald @andys8 @antoinebrault @gstamac @ExE-Boss @quassnoi @Belco90 @tonyhallett @ycmjason @pawfa @gerkindev @domdomegg @mrazauskas -/types/jest/v16/ @NoHomey @jwbay @ExE-Boss /types/jest-axe/ @erbridge /types/jest-dev-server/ @ifiokjr @UziTech /types/jest-environment-puppeteer/ @ifiokjr @@ -3705,7 +3676,6 @@ /types/jest-matcher-one-of/ @joemitchard /types/jest-plugin-context/ @jonasheinrich /types/jest-plugin-set/ @jonasheinrich -/types/jest-preset-stylelint/ @marcfallows /types/jest-sinon/ @seidelmartin /types/jest-specific-snapshot/ @dawnmist /types/jest-when/ @aldentaylor @immanuel192 @gstamac @hipsterbrown @boginw @@ -3906,7 +3876,7 @@ /types/jshamcrest/ @dharkness /types/jshint/ @aminya /types/jskana/ @peterblazejewicz -/types/jslib-html5-camera-photo/ @Vestride +/types/jslib-html5-camera-photo/ @glen-cheney /types/jsmediatags/ @gunnim /types/jsmidgen/ @jimmycuadra /types/jsmockito/ @shiver-me-timbers @@ -3941,7 +3911,6 @@ /types/json-schema-merge-allof/ @forivall /types/json-server/ @jeremyben /types/json-socket/ @svi3c -/types/json-stable-stringify/ @mhfrantz /types/json-stable-stringify-without-jsonify/ @davwheat /types/json-stream/ @trim21 /types/json-string-splitter/ @jeswr @@ -4339,7 +4308,6 @@ /types/lesgo/v0.6/ @xxlxx /types/less/ @thasner @pranaygp @chigix /types/less-middleware/ @federicobond -/types/level/ @danielfx90 /types/level-codec/ @danwbyrne /types/level-errors/ @yoursunny /types/level-js/ @danwbyrne @@ -4740,7 +4708,6 @@ /types/loopbench/ @BendingBender /types/looper/ @jacobbubu /types/lory.js/ @kubosho -/types/lossless-json/ @andrevmatos /types/lost/ @MysteryBlokHed /types/lovefield/ @freshp86 @zackzeno /types/lowdb/ @typicode @niieani @@ -4759,6 +4726,7 @@ /types/lucasmogari__react-pagination/ @LauraBeatris /types/lucene/ @bengry @HugoMuller /types/lucene-escape-query/ @vicary +/types/lucene-query-string-builder/ @jinkijung /types/luhn-generator/ @peterblazejewicz /types/luminous-lightbox/ @yuNuki2 /types/lunr/ @seantanly @hokiegeek @@ -4775,6 +4743,7 @@ /types/lzbase62/ @ArthurKa /types/lzma/ @Goldsmith42 /types/lzma-native/ @leshow +/types/m3u8-parser/ @k-yle /types/macaca-circular-json/ @jpevarnek /types/macrotask/ @BendingBender /types/madge/ @jasongerbes @@ -4994,7 +4963,6 @@ /types/methods/ @cprecioso @michelbitter /types/metric-suffix/ @davidm77 /types/metrostations/ @peterblazejewicz -/types/meyda/ @eramdam @hughrawlinson /types/mfiles/ @avonwyss /types/mg-api-js/ @kadensharpin /types/micro-cors/ @CallumDenby @moonchanyong @@ -5140,7 +5108,6 @@ /types/mpromise/ @sgkim126 /types/mpv-script/ @mrxdst /types/mraid/ @sumn2u -/types/mrz/ @forivall /types/ms/ @danny8002 /types/ms.macro/ @ckknight /types/msgpack/ @enrapt-mochizuki @@ -5358,7 +5325,6 @@ /types/node-kmeans/ @aquine-kujaruk /types/node-localstorage/ @intolerance /types/node-loggly-bulk/ @akazakou -/types/node-mailjet/ @Nikola-Andreev @jordangarvey @qqilihq /types/node-media-server/ @Tseberechts @princefishthrower /types/node-memwatch/ @Kroisse /types/node-microphone/ @Maanex @@ -5403,7 +5369,6 @@ /types/node-snap7/ @heilingbrunner /types/node-sprite-generator/ @Perlmint /types/node-ssdp/ @OrionNebula -/types/node-ssh/ @yoursunny /types/node-ssha256/ @midgleyc /types/node-static/ @Morfent /types/node-statsd/ @alexturek @convoyinc @@ -5459,6 +5424,7 @@ /types/normalize-package-data/ @jdxcode /types/normalize-path/ @BendingBender /types/noteflight-client/ @nickslick03 +/types/notiad-sdk/ @ykavras /types/notie/ @mateusdemboski @MysteryBlokHed /types/notify/ @hellochar /types/notifyjs/ @soundTricker @NateScarlet @eikendev @@ -5862,7 +5828,6 @@ /types/phc__format/ @filiafobico /types/phoenix/ @mciastek @John-Goff @princemaple /types/phoenix_live_view/ @pzingg -/types/phone/ @DxCx @brimtown /types/phone-formatter/ @westy92 /types/phoneformat.js/ @ffflorian /types/phonegap/ @borisyankov @DickvdBrink @@ -5889,6 +5854,7 @@ /types/picturefill/ @alaz /types/pid-from-port/ @BendingBender /types/pidusage/ @cyrilschumacher +/types/piexifjs/ @Cygra /types/pify/ @samverschueren @mad-mike @c7hm4r /types/pikaday/ @MidnightDesign @wake42 @mezoistvan /types/pikaday-time/ @Sayan751 @@ -5936,7 +5902,6 @@ /types/pngjs/ @jason0x43 @ffflorian @peterblazejewicz /types/pngquant-bin/ @hikoma /types/pnpapi/ @arcanis @ExE-Boss -/types/podcast/ @nikeee @malob /types/podium/ @AJamesPhillips /types/poi/ @bolasblack /types/point-in-polygon/ @dyst5422 @kogai @@ -6190,7 +6155,6 @@ /types/qrcode/ @plantain-00 @mnahkies @Marchelune @BendingBender /types/qrcode-svg/ @ericbf /types/qrcode-terminal/ @baltpeter -/types/qrcode.react/ @mleko @yonasadiel @bjoluc /types/qrcodejs/ @peterblazejewicz /types/qs/ @RWander @leonyu @tehbelinda @zyml @artursvonda @CarlosBonetti @dpsmith3 @hperrin @ljharb /types/qs-middleware/ @davecardwell @@ -6254,7 +6218,6 @@ /types/range-inclusive/ @BendingBender /types/range-map/ @dallinskinner /types/range-parser/ @tlaziuk -/types/range_check/ @ItsMajestiX /types/rangyinputs/ @ersimont /types/raphael/ @CheCoxshall @blutorange /types/rappid/ @DenEwout @@ -6365,7 +6328,6 @@ /types/react-bootstrap-table2-filter/ @gosticks /types/react-bootstrap-table2-paginator/ @gosticks /types/react-bootstrap-table2-toolkit/ @gosticks -/types/react-bootstrap-typeahead/ @Guymestef @radziksh @PaitoAnderson @arichter83 @dalevfenton @KngHawkon @Chrisdo82 /types/react-breadcrumbs/ @guoyunhe @matsuby /types/react-breadcrumbs-dynamic/ @mitsuruog /types/react-broadcast/ @kandros @@ -6376,6 +6338,7 @@ /types/react-calendar-timeline/ @radziksh @rip21 @joncar /types/react-canvas-draw/ @ksocha /types/react-cartographer/ @trevonmckay +/types/react-chessground/ @leemhoon00 @MEGUMMY1 /types/react-circular/ @rhythmbhiwani /types/react-click-outside/ @screendriver @Ky6uk /types/react-click-outside-hook/ @bdeloeste @@ -6397,7 +6360,6 @@ /types/react-copy-write/ @samhh @davej /types/react-count-to/ @pwolaq /types/react-credit-cards/ @vstrimaitis @olefrank @zzanol -/types/react-cropper/ @bwlt @frisi /types/react-css-collapse/ @dford07 /types/react-css-modules/ @KostyaEsmukov @skirsdeda /types/react-css-transition-replace/ @LKay @@ -6405,7 +6367,6 @@ /types/react-currency-format/ @guilhermefront /types/react-currency-formatter/ @pastushenkoy @Jeka-Vasiliev /types/react-curved-text/ @gausie -/types/react-custom-scroll/ @rommguy @rvdende /types/react-custom-scrollbars/ @kittimiyo /types/react-cytoscapejs/ @manuc66 @newraina /types/react-d3-graph/ @adina-todoran @BreadAndRoses95 @TranquilMarmot @@ -6516,7 +6477,6 @@ /types/react-input-autosize/ @jsonunger @franklixuefei /types/react-input-mask/ @apare @dima7a14 @lucasraziel /types/react-input-mask/v1/ @apare -/types/react-inspector/ @rogerclotet @chenxinyanc /types/react-instantsearch/ @gburgett @jpowell @haroenv @samouss /types/react-instantsearch-core/ @gburgett @jpowell @davidfurlong @haroenv @samouss /types/react-instantsearch-dom/ @gburgett @jpowell @haroenv @samouss @@ -6545,8 +6505,6 @@ /types/react-lazyload-youtube/ @MysteryBlokHed /types/react-lazylog/ @benjaminRomano @abemedia /types/react-leaflet-fullscreen-plugin/ @Zenoo -/types/react-leaflet-markercluster/ @ciaccodavide -/types/react-leaflet-markercluster/v2/ @Kimahriman /types/react-leaflet-pixi-overlay/ @Guilherm456 /types/react-leaflet-sidebarv2/ @vikram-gsu /types/react-lifecycle-component/ @pixelshaded @@ -6643,7 +6601,6 @@ /types/react-native-keep-awake/ @huhuanming /types/react-native-keyboard-spacer/ @VincentLanglet /types/react-native-listener/ @ChintanAcharya -/types/react-native-loading-spinner-overlay/ @fhelwanger /types/react-native-material-design-searchbar/ @iRoachie /types/react-native-material-dropdown/ @jaydeep987 @mchappell /types/react-native-material-kit/ @iRoachie @timwangdev @@ -6700,7 +6657,6 @@ /types/react-native-table-component/ @davidcole1340 /types/react-native-tags/ @IdaszakDaniel /types/react-native-telnet-client/ @robinvandenb -/types/react-native-text-input-mask/ @RodrigoAWeber @hengkx /types/react-native-toast-native/ @bm-software /types/react-native-torch/ @BenLorantfy /types/react-native-typewriter/ @ScreamZ @@ -6774,8 +6730,6 @@ /types/react-request/ @dannycochran @angusfretwell @jonathanly @albertojuanl /types/react-resizable/ @airhorns /types/react-resolver/ @forabi -/types/react-responsive/ @asvetliakov @alechill @xaviergonz -/types/react-responsive/v1/ @asvetliakov /types/react-responsive-embed/ @Methuselah96 /types/react-responsive-masonry/ @themashcodee /types/react-responsive-spritesheet/ @triangularcube @@ -6823,6 +6777,7 @@ /types/react-sortable-tree-theme-file-explorer/ @dolezel /types/react-sound/ @koss-lebedev @PaitoAnderson /types/react-sparklines/ @henrinormak +/types/react-speech-kit/ @SamQuail /types/react-speech-recognition/ @OleksandrYehorov /types/react-spinkit/ @tkqubo @mleko @pelotom @zzanol /types/react-spinkit/v1/ @tkqubo @mleko @pelotom @@ -7120,6 +7075,7 @@ /types/reveal.js/ @robertop87 @JPtenBerge /types/rewire/ @borislavjivkov @CaselIT /types/rfc2047/ @mugifly +/types/rfc2253/ @arndissler /types/rgrove__parse-xml/ @petejohanson /types/rheostat/ @kourge @StefanWerW /types/rickshaw/ @niemyjski @@ -7165,7 +7121,6 @@ /types/rollup-plugin-svelte-svg/ @GauBen /types/rollup-plugin-url/ @me /types/rollup-plugin-visualizer/ @fobdy @maxbogus -/types/rollup__plugin-virtual/ @ahum /types/roman-numerals/ @pluma /types/romans/ @peterblazejewicz /types/ronilaukkarinen__gulp-stylelint/ @martin-badin @@ -7235,6 +7190,7 @@ /types/rx-lite-virtualtime/ @Igorbek /types/rx-node/ @andre-luiz-dos-santos /types/rx.wamp/ @darkl +/types/s-salt-pepper/ @kguzek /types/s3-download-stream/ @everettcaleb /types/s3-streams/ @azatoth /types/s3-upload-stream/ @geoffreak @@ -7246,7 +7202,6 @@ /types/safe-flat/ @paambaati /types/safe-json-stringify/ @ericbyers /types/safe-regex/ @ImRodry -/types/safe-regex-test/ @BendingBender /types/safe-timers/ @ksocha /types/safer-buffer/ @ffflorian /types/sails.io.js/ @arvitaly @@ -7279,7 +7234,6 @@ /types/saslprep/ @BendingBender /types/sass-graph/ @marvinhagemeister /types/sass-loader/ @JasonHK -/types/sass-true/ @robertmaier /types/sat/ @omni360 /types/satnav/ @DotNetNerd /types/saturn-web/ @wrongsahil @@ -7588,7 +7542,6 @@ /types/slip/ @Finomnis /types/sloc/ @garyking /types/slocket/ @BendingBender -/types/slonik/ @sebald @mmkal /types/slug/ @danielclausmeyer /types/sluggo/ @RDIL /types/sm-crypto/ @Moonisky @@ -7940,7 +7893,7 @@ /types/swagger-ui/ @juarrow @peterblazejewicz /types/swagger-ui-dist/ @haowen737 @brycematheson1234 @peterblazejewicz /types/swagger-ui-express/ @dmitryrogozhny @ffflorian -/types/swagger-ui-react/ @VictoriaGreen93 @afrkorsakow +/types/swagger-ui-react/ @VictoriaGreen93 @afrkorsakow @davulrich /types/swagger2openapi/ @rxliuli /types/swaggerize-express/ @mugeso @nickmorton /types/swe-validation/ @hjalmers @@ -7992,7 +7945,7 @@ /types/tape/ @Bartvds @sodatea @DennisSchwartz @mikehenrty @rostrowski @ljharb /types/tape-async/ @ExE-Boss /types/tape-catch/ @ExE-Boss -/types/tape-promise/ @ExE-Boss +/types/tape-promise/ @ExE-Boss @ljharb /types/tar/ @SomaticIT @connor4312 /types/tar-fs/ @Umoxfo @chriswiggins /types/tar-js/ @Narazaka @@ -8009,10 +7962,10 @@ /types/tdigest/ @BendingBender /types/tdweb/ @esindger /types/teddy/ @lannonbr -/types/tedious/ @rogierschouten @cjthompson @guiampm @csharpsi /types/tedious-connection-pool/ @sandorfr /types/teen_process/ @NotWoods /types/telebot/ @mariotsi @martin-badin +/types/telegram-mini-app/ @dartweider2000 /types/telegram-web-app/ @KnorpelSenf @MKRhere @deptyped /types/telnetlib/ @martin-badin /types/temp/ @DanielRosenwasser @@ -8206,7 +8159,6 @@ /types/tryer/ @bengry /types/tryghost__content-api/ @knguyen0125 @antonve @maveric1977 /types/ts-nameof/ @dsherret -/types/tsc-watch/ @peterblazejewicz /types/tspromise/ @soywiz /types/tsqlstring/ @srencat /types/tsscmp/ @g-rath @@ -8288,7 +8240,6 @@ /types/umd/ @TeamworkGuy2 /types/umtrack-wx/ @azzgo /types/umzug/ @drinchev @mlamp @trodi @emmanuelgautier -/types/unbox-primitive/ @BendingBender /types/unbzip2-stream/ @plumdog /types/unc-path-regex/ @BendingBender /types/underscore/ @borisyankov @jbaldwin @ccurrens @confususs @jgonggrijp @ffflorian @regevbr @peterblazejewicz @reubenrybnik @LukeGT @@ -8512,6 +8463,7 @@ /types/vscode-webview/ @mjbvz /types/vscode-windows-registry/ @bpasero /types/vssln-parser/ @erik-kallen +/types/vt-pbf/ @skwash /types/vtex.js/ @IncognitaDev /types/vue-barcode-reader/ @julisch94 /types/vue-chartkick/ @cnsmedia @@ -8536,6 +8488,7 @@ /types/vue2-editor/ @suryadana /types/vue2-hammer/ @ptandler /types/vue3-carousel-3d/ @tevem1207 +/types/vue3-json-viewer/ @String10 /types/vuelidate/ @janesser @shadrus /types/vusion__webfonts-generator/ @atlowChemi /types/vxna__mini-html-webpack-template/ @peterblazejewicz @@ -8637,7 +8590,6 @@ /types/webpack-hot-client/ @ZSkycat @barm /types/webpack-hot-middleware/ @bumbleblym @icylace @chrisabrams @iliyaZelenko @saboya /types/webpack-livereload-plugin/ @peterblazejewicz -/types/webpack-manifest-plugin/ @r3nya @monsonjeremy /types/webpack-merge-and-include-globally/ @peterblazejewicz /types/webpack-node-externals/ @mtraynham @MrSpoocy @peterblazejewicz /types/webpack-react-component-name/ @DorianLatchague @@ -8685,7 +8637,6 @@ /types/when/ @derekcicerone @Nemo157 /types/when-dom-ready/ @BendingBender /types/which/ @vvakame @cspotcode @peterblazejewicz -/types/which-boxed-primitive/ @BendingBender /types/which-pm-runs/ @shian15810 /types/which-polygon/ @k-yle /types/whitelist-object/ @BendingBender @@ -8746,11 +8697,8 @@ /types/wordpress__block-library/ @dsifford /types/wordpress__block-serialization-spec-parser/ @dsifford /types/wordpress__blocks/ @dsifford @sirreal @dmsnell @tomasztunik @sunyatasattva @bastolen -/types/wordpress__custom-templated-path-webpack-plugin/ @dsifford /types/wordpress__customize-browser/ @marekdedic /types/wordpress__edit-post/ @dsifford -/types/wordpress__library-export-default-webpack-plugin/ @dsifford -/types/wordpress__shortcode/ @dsifford /types/wordpress__viewport/ @dsifford /types/wordpress__wordcount/ @dsifford /types/words-to-time-converter/ @peterblazejewicz @@ -8805,7 +8753,6 @@ /types/xml-flow/ @Warerebel /types/xml-name-validator/ @doug-wade /types/xml-parser/ @mhfrantz -/types/xml-zero-lexer/ @943297456 /types/xml2js/ @michelsalib @jasonrm @ccurrens @edwardhinkle @claasahl @redlickigrzegorz @72636c /types/xml2json/ @dolanmiu @xamgore /types/xmldoc/ @Xstoudi @ajsheehan @notlaforge @@ -8919,14 +8866,15 @@ /types/zen-observable/ @aicest @JounQin @itomtom @BenoitZugmeyer /types/zen-push/ @daprahamian /types/zenaton/ @jalric +/types/zendesk-web-widget/ @forivall /types/zengin-code/ @takahash /types/zenscroll/ @HamedFathi /types/zepto/ @jbaldwin /types/zeroclipboard/ @ejsmith @niemyjski @balassy @leonyu /types/zeroclipboard/v1/ @ejsmith @niemyjski @balassy @leonyu /types/zeromq/ @davemckeown @TitaneBoy @overflowz -/types/zetrix-encryption-nodejs/ @izadimrantan -/types/zetrix-sdk-nodejs/ @izadimrantan +/types/zetrix-encryption-nodejs/ @armmarov @izadimrantan +/types/zetrix-sdk-nodejs/ @armmarov @izadimrantan /types/zfont/ @demensky /types/zingchart/ @jeanettephung /types/zinggrid/ @jeanettephung diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 64afae9d93b077d..e8cc2adb24c04ba 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -35,7 +35,7 @@ jobs: # Need this to be able to inquire about origin/master filter: blob:none # https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/ fetch-depth: 0 # Default is 1; need to set to 0 to get the benefits of blob:none. - - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0 + - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0 with: node-version: '20' @@ -67,7 +67,7 @@ jobs: # Need this to be able to inquire about origin/master filter: blob:none # https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/ fetch-depth: 0 # Default is 1; need to set to 0 to get the benefits of blob:none. - - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0 + - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0 with: node-version: '20' @@ -115,7 +115,7 @@ jobs: if: ${{ github.event_name == 'pull_request' }} - name: Upload suggestions - uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 + uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0 with: name: suggestions_${{ matrix.shardId }}_${{ matrix.shardCount }} if-no-files-found: ignore diff --git a/.github/workflows/UpdateCodeowners.yml b/.github/workflows/UpdateCodeowners.yml index bb6f23d776b5017..9a0bf84b71169bd 100644 --- a/.github/workflows/UpdateCodeowners.yml +++ b/.github/workflows/UpdateCodeowners.yml @@ -32,7 +32,7 @@ jobs: - run: pnpm run update-codeowners - - uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # v5.0.1 + - uses: stefanzweifel/git-auto-commit-action@e348103e9026cc0eee72ae06630dbe30c8bf7a79 # v5.1.0 with: commit_author: 'TypeScript Bot ' commit_message: '🤖 Update CODEOWNERS' diff --git a/.github/workflows/format-and-commit.yml b/.github/workflows/format-and-commit.yml index 1cbbb22a7e62a62..f2d242fda8fca90 100644 --- a/.github/workflows/format-and-commit.yml +++ b/.github/workflows/format-and-commit.yml @@ -40,7 +40,7 @@ jobs: - run: pnpm dprint fmt - - uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # v5.0.1 + - uses: stefanzweifel/git-auto-commit-action@e348103e9026cc0eee72ae06630dbe30c8bf7a79 # v5.1.0 with: commit_author: 'TypeScript Bot ' commit_message: '🤖 dprint fmt' diff --git a/.github/workflows/ghostbuster.yml b/.github/workflows/ghostbuster.yml index a335b86e3576b3a..2a2762ab373cc6a 100644 --- a/.github/workflows/ghostbuster.yml +++ b/.github/workflows/ghostbuster.yml @@ -42,7 +42,7 @@ jobs: fi - if: ${{ inputs.skipPR != 'true' }} - uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # v7.0.5 + uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6 with: token: ${{ secrets.GITHUB_TOKEN }} commit-message: 'Remove contributors with deleted accounts #no-publishing-comment' diff --git a/.github/workflows/pnpm-cache.yml b/.github/workflows/pnpm-cache.yml index be82ab7930927ec..f05c788c821cc2e 100644 --- a/.github/workflows/pnpm-cache.yml +++ b/.github/workflows/pnpm-cache.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0 + - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0 with: node-version: '20' - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 diff --git a/.github/workflows/support-window.yml b/.github/workflows/support-window.yml index 1db491ee4efb716..d66d1baf2e2eebd 100644 --- a/.github/workflows/support-window.yml +++ b/.github/workflows/support-window.yml @@ -43,7 +43,7 @@ jobs: - name: Make SVG diagram run: node --experimental-json-modules scripts/support-window > docs/support-window.svg - - uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # v5.0.1 + - uses: stefanzweifel/git-auto-commit-action@e348103e9026cc0eee72ae06630dbe30c8bf7a79 # v5.1.0 with: commit_author: 'TypeScript Bot ' commit_message: '🤖 Update support window' diff --git a/README.fr.md b/README.fr.md index bd511172749c99b..ab3df440cd3e0e0 100644 --- a/README.fr.md +++ b/README.fr.md @@ -2,37 +2,49 @@ > Le référentiel des définitions de type TypeScript de _haute qualité_. -_Vous pouvez également lire ce README en [Español](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.es.md), [한국어](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.ko.md), [Русский](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.ru.md), [简体中文](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.zh-Hans.md), [Português](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.pt.md), [Italiano](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.it.md), [日本語](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.ja.md) et [Français](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.fr.md)!_ +_Vous pouvez également lire ce README en [Español](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.es.md), [한국어](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.ko.md), [Русский](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.ru.md), [简体中文](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.zh-Hans.md), [Português](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.pt.md), [Italiano](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.it.md), [日本語](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.ja.md) et [English](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md)!_ _Lien vers le [Manuel de l'administrateur](./docs/admin.md)_ +## !!! Important ! Ce dépôt a récemment changé de structure ! !!! + +Definitely Typed est récemment passé sur un véritable monorepo `pnpm`; vous voudriez peut-être relire ce document pour connaître les changements apportés à la structure des packages dans ce dépôt. + +Au minimum, vous voudriez peut-être faire un `git clean -fdx` sur le dépôt (ou `node ./scripts/clean-node-modules.js` sur Windows) pour nettoyer `node_modules` et exécuter `pnpm install --filter .` pour installer la racine du workspace. Voir les sections suivantes pour plus d'informations sur `pnpm install`. + ## État actuel Cette section permet de suivre l'état de santé du référentiel et du processus de publication. -Elle peut être utile aux contributeurs qui rencontrent des problèmes avec leurs PR et leurs paquets. +Elle peut être utile aux contributeurs qui rencontrent des problèmes avec leurs PR et leurs packages. -- Dernière version [type-checked/linted](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/dtslint) proprement: [![Build Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.DefinitelyTyped?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=1&branchName=master) -- Tous les paquets font l'objet d'une vérification de type et d'un marquage propre sur typescript@next: [![Build Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/Nightly%20dtslint)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=8) -- Tous les paquets en cours de [Publication sur npm](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/publisher) en moins d'une heure et demie : [![Publish Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.types-publisher-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=5&branchName=master) -- [typescript-bot](https://github.com/typescript-bot) a été actif sur Definitely Typed [![Activity Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) -- Actuel [mise à jour de l'état de l'infrastructure](https://github.com/DefinitelyTyped/DefinitelyTyped/issues/44317) +- Dernière version [type-checked/linted](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/dtslint) proprement : [![Build status](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/CI.yml/badge.svg?branch=master&event=push)](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/CI.yml?query=branch%3Amaster+event%3Apush) +- Tous les packages passent la vérification des types et du linter : [![Build status](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/CI.yml/badge.svg?branch=master&event=schedule)](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/CI.yml?query=branch%3Amaster+event%3Aschedule) +- Tous les packages ont été [publié sur npm](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/publisher) en moins d'une heure et demie : [![Publish Status](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/watchdog-publisher.yml/badge.svg)](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/watchdog-publisher.yml) +- [typescript-bot](https://github.com/typescript-bot) a été actif sur Definitely Typed [![Activity Status](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/watchdog-typescript-bot.yml/badge.svg)](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/watchdog-typescript-bot.yml) +- [Mise à jour de l'état de l'infrastructure](https://github.com/DefinitelyTyped/DefinitelyTyped/issues/44317) actuel -Si quelque chose ne semble pas fonctionner, ou si l'un des éléments ci-dessus échoue, merci de nous le faire savoir dans [le canal Definitely Typed sur le serveur Discord de la Communauté TypeScript](https://discord.gg/typescript). +Si quelque chose semble incorrect ou si l'un des éléments ci-dessus échoue, merci de nous le faire savoir dans [le canal Definitely Typed sur le serveur Discord de la Communauté TypeScript](https://discord.gg/typescript). -## Qu'est-ce qu'un fichier de déclaration et comment puis-je l'obtenir ? +## Que sont les fichiers de déclaration et comment les obtenir ? Voir le [Manuel TypeScript](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html). ### npm -C'est la méthode préférée. Par exemple : +C'est la méthode privilégiée. Par exemple : ```sh npm install --save-dev @types/node ``` +Pour installer des types d'un module scopé, remplacez le `@` par deux underscore après le scope. Par exemple, pour installer des types pour `@babel/preset-env` : + +```sh +npm install --save-dev @types/babel__preset-env +``` + Les types devraient alors être automatiquement inclus par le compilateur. -Vous pouvez avoir besoin d'ajouter une référence `types` si vous n'utilisez pas de modules : +Vous pourriez avoir besoin d'ajouter une référence `types` si vous n'utilisez pas de modules : ```ts /// @@ -40,17 +52,17 @@ Vous pouvez avoir besoin d'ajouter une référence `types` si vous n'utilisez pa Plus d'informations dans le [manuel](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html). -Pour un paquet npm "foo", les typages pour celui-ci seront à "@types/foo".. +Pour un package npm "foo", les types pour celui-ci seront dans "@types/foo". -Si votre paquet a des typages spécifiés en utilisant la clé `types` ou `typings` dans son `package.json`, le registre npm affichera que le paquet a des bindings disponibles comme ceci : +Si votre package spécifie des types avec la clé `types` ou `typings` dans son `package.json`, le registre npm affichera que le package a des bindings disponibles comme ceci : ![image](https://user-images.githubusercontent.com/30049719/228748963-56fabfd1-9101-42c2-9891-b586b775b01e.png) -Si vous ne trouvez toujours pas les typages, recherchez simplement les fichiers ".d.ts" dans le paquet et incluez-les manuellement avec une commande `/// `. +Si vous ne trouvez toujours pas les types, recherchez simplement les fichiers ".d.ts" dans le package et incluez-les manuellement avec `/// `. ### Support de version -Definitely Typed ne teste que les paquets sur des versions de TypeScript datant de moins de 2 ans. +Definitely Typed ne teste que les packages sur des versions de TypeScript datant de moins de 2 ans. @@ -58,7 +70,7 @@ Definitely Typed ne teste que les paquets sur des versions de TypeScript datant
Anciennes versions de TypeScript -Les paquets `@types` ont des étiquettes pour les versions de TypeScript qu'ils supportent explicitement, de sorte que vous pouvez généralement obtenir des versions plus anciennes de paquets qui précèdent la fenêtre de 2 ans. +Les packages `@types` ont des tags pour les versions de TypeScript qu'ils supportent explicitement, de sorte que vous pouvez généralement obtenir des versions plus anciennes des packages qui précèdent la fenêtre de 2 ans. Par exemple, si vous lancez `npm dist-tags @types/react`, vous verrez que TypeScript 2.5 peut utiliser les types pour react@16.0, alors que TypeScript 2.6 et 2.7 peuvent utiliser les types pour react@16.4 : | Tag | Version | @@ -77,7 +89,7 @@ Par exemple, si vous lancez `npm dist-tags @types/react`, vous verrez que TypeSc - ~~[Typings](https://github.com/typings/typings)~~ (utilisez les alternatives préférées, typings est déprécié) - ~~[NuGet](https://nuget.org/packages?q=DefinitelyTyped)~~ (utilisez les alternatives préférées, la publication des types DT de Nuget a été désactivée) -Vous pouvez avoir besoin d'ajouter le manuel [references](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html). +Vous pourriez avoir besoin d'ajouter le manuel [references](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html).
@@ -96,13 +108,13 @@ declare module "libname" { } ``` -#### Test d'édition d'un paquet existant +#### Test d'édition d'un package existant Vous pouvez éditer les types directement dans `node_modules/@types/foo/index.d.ts` pour valider vos changements, puis apporter les changements à ce repo avec les étapes ci-dessous. Alternativement, vous pouvez utiliser [module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation) pour étendre les types existants du module DT ou utiliser la technique `declare module` ci-dessus qui remplacera la version dans `node_modules`. -#### Ajouter des tests à un nouveau paquet +#### Ajouter des tests à un nouveau package Ajoutez-le à votre `tsconfig.json` : @@ -115,128 +127,208 @@ Créez `types/foo/index.d.ts` contenant les déclarations pour le module "foo". Vous devriez maintenant être capable d'importer `"foo"` dans votre code et il sera dirigé vers la nouvelle définition de type. Ensuite, compilez _et_ exécutez le code pour vous assurer que votre définition de type correspond bien à ce qui se passe à l'exécution. -Une fois que vous avez testé vos définitions avec du code réel, faites un [PR](#faire-une-demande-de-pull-request) -puis suivez les instructions pour [modifier un paquet existant](#modifier-un-paquet-existant) ou -[créer un nouveau paquet](#créer-un-nouveau-paquet). +Une fois que vous avez testé vos définitions avec du code réel, faites une [PR](#faire-une-demande-de-pull-request) +puis suivez les instructions pour [modifier un package existant](#modifier-un-package-existant) ou +[créer un nouveau package](#créer-un-nouveau-package). ### Faire une demande de pull request -Une fois que vous avez testé votre paquet, vous pouvez le partager sur Definitely Typed. +Une fois que vous avez testé votre package, vous pouvez le partager sur Definitely Typed. -Tout d'abord, [fork](https://guides.github.com/activities/forking/) ce dépôt, [clone](#partial-clone), installez [node](https://nodejs.org/), et lancez `npm install`. Si vous utilisez `npm` v7, vous devez ajouter le drapeau `--legacy-peer-deps` à la commande. +Tout d'abord, [forkez](https://guides.github.com/activities/forking/) ce dépôt, [clonez](#partial-clone) le, +installez [node](https://nodejs.org/), et lancez `npm install`. Notez que `pnpm install` installera _l'intégralité_ +du dépôt, y compris des packages que vous ne modifiez peut-être pas. Si vous souhaitez installer uniquement un sous-ensemble, +vous pouvez lancer `pnpm install -w --filter "{./types/foo}..."` pour installer `@types/foo` et +toutes ses dépendances. Si vous avez besoin de lancer des tests de packages qui _dépendent_ de `@types/foo`, vous pouvez lancer `pnpm install -w --filter "...{./types/foo}..."` pour récupérer tous les packages associés nécessaires aux tests. -Nous utilisons un robot pour permettre à un grand nombre de pull requests vers DefinitelyTyped d'être traitées entièrement en libre-service. Vous pouvez en savoir plus sur [pourquoi et comment ici](https://devblogs.microsoft.com/typescript/changes-to-how-we-manage-definitelytyped/). Voici une référence pratique montrant le cycle de vie de pull request à DT : +> [!NOTE] +> Si vous utilisez Windows, vous constaterez peut-être que `git clean` ne supprime pas le répertoire `node_modules` ou se bloque lors de cette opération. Si vous devez supprimer `node_modules`, vous pouvez lancer `pnpm clean-node-modules` pour réinitialiser le dépôt. - +Nous utilisons un bot pour permettre à un grand nombre de pull requests de DefinitelyTyped d'être traitées entièrement en libre-service. Vous pouvez en savoir plus sur [pourquoi et comment ici](https://devblogs.microsoft.com/typescript/changes-to-how-we-manage-definitelytyped/). Voici une référence pratique montrant le cycle de vie de pull request à DT : + + #### Partial clone
-Vous pouvez cloner l'ensemble du dépôt comme d'habitude, mais il est volumineux et comprend un énorme répertoire de paquets de type. +Vous pouvez cloner l'ensemble du dépôt comme d'habitude, mais il est volumineux et comprend un énorme répertoire de packages de type. -Vous pouvez cloner l'ensemble du dépôt [comme d'habitude](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository), mais il est volumineux et comprend un énorme répertoire de paquets de type. Cela prendra du temps à cloner et peut s'avérer inutilement lourd. +Vous pouvez cloner l'ensemble du dépôt [comme d'habitude](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository), mais il est volumineux et comprend un énorme répertoire de packages de type. Cela prendra du temps à cloner et peut s'avérer inutilement lourd. -Pour un clone plus facile à gérer qui inclut _seulement_ les paquets de type qui vous concernent, vous pouvez utiliser les fonctionnalités de git [`sparse-checkout`](https://git-scm.com/docs/git-sparse-checkout), [`--filter`](https://git-scm.com/docs/git-rev-list#Documentation/git-rev-list.txt---filterltfilter-specgt), et [`--depth`](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthltdepthgt). Cela réduira le temps de clonage et améliorera les performances de git. +Pour un clone plus facile à gérer qui inclut _seulement_ les packages de type qui vous concernent, vous pouvez utiliser les fonctionnalités de git [`sparse-checkout`](https://git-scm.com/docs/git-sparse-checkout), [`--filter`](https://git-scm.com/docs/git-rev-list#Documentation/git-rev-list.txt---filterltfilter-specgt), et [`--depth`](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthltdepthgt). Cela réduira le temps de clonage et améliorera les performances de git. > :warning: Ceci nécessite au minimum [git version 2.27.0](https://git-scm.com/downloads), qui est probablement plus récent que la version par défaut sur la plupart des machines. Des procédures plus complexes sont disponibles dans les versions plus anciennes, mais ne sont pas couvertes par ce guide. -1. `git clone --sparse --filter=blob:none --depth=1 ` +1. `git clone --sparse --filter=blob:none ` - `--sparse` initialise le fichier sparse-checkout afin que le répertoire de travail ne contienne au départ que les fichiers situés à la racine du référentiel. - `--filter=blob:none` exclura des fichiers, les récupérant uniquement en cas de besoin. - - `--depth=1` améliorera encore la vitesse de clonage en tronquant l'historique des livraisons, mais il peut causer des problèmes, comme le résume le tableau suivant [ici](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/). 2. `git sparse-checkout add types/ types/ ...`
-#### Modifier un paquet existant +#### Modifier un package existant -- `cd types/` -- Apporter des modifications. N'oubliez pas d' [éditer les tests](#mon-paquet-teststs). - Si vous apportez des modifications radicales, n'oubliez pas de [mettre à jour une version majeure](#si-une-bibliothèque-est-mise-à-jour-vers-une-nouvelle-version-majeure-comportant-des-changements-importants-comment-dois-je-mettre-à-jour-son-paquet-de-déclarations-de-types-). -- [Run `npm test `](#exécution-des-tests). +- Apporter des modifications. N'oubliez pas d'[éditer les tests](#mon-package-teststs). + Si vous apportez des modifications radicales, n'oubliez pas de [mettre à jour la version majeure](#si-une-bibliothèque-est-mise-à-jour-vers-une-nouvelle-version-majeure-comportant-des-changements-importants-comment-dois-je-mettre-à-jour-son-package-de-déclarations-de-types-). +- [Run `npm test `](#exécution-des-tests). -Quand vous faites une PR pour éditer un paquet existant, `dt-bot` devrait @-mentionner les auteurs précédents. -S'il ne le fait pas, vous pouvez le faire vous-même dans le commentaire associé à la PR. +Quand vous faites une PR pour éditer un package existant, `dt-bot` devrait @-mentionner les auteurs du package. +S'il ne le fait pas, vous pouvez le faire vous-même dans un commentaire associé à la PR. -#### Créer un nouveau paquet +#### Créer un nouveau package -Si vous êtes l'auteur de la bibliothèque et que votre paquetage est écrit en TypeScript, [regroupez les fichiers de déclaration autogénérés](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) dans votre paquetage au lieu de publier sur Definitely Typed. +Si vous êtes l'auteur de la lib et que votre package est écrit en TypeScript, [regroupez les fichiers de déclaration autogénérés](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) dans votre package au lieu de le publier sur Definitely Typed. +Vous pouvez également générer des fichiers de déclaration à partir de fichiers JavaScript, en utilisant JSDoc pour les annotations de type. -Si vous ajoutez des typages pour un paquetage npm, créez un répertoire avec le même nom. -Si le paquet pour lequel vous ajoutez des typages n'est pas sur npm, assurez-vous que le nom que vous choisissez pour lui n'entre pas en conflit avec le nom d'un paquet sur npm. -(Vous pouvez utiliser `npm info ` pour vérifier l'existence du paquet ``). +Si vous ajoutez des typages pour un package npm, créez un répertoire avec le même nom. +Si le package pour lequel vous ajoutez des typages n'est pas sur npm, assurez-vous que le nom que vous choisissez pour lui n'entre pas en conflit avec le nom d'un package sur npm. +(Vous pouvez utiliser `npm info ` pour vérifier l'existence du package ``). -Votre paquet doit avoir cette structure : +Votre package doit avoir cette structure : -| Fichier | Objectif | -| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| `index.d.ts` | Il contient les typages du paquet. | -| [`-tests.ts`](#mon-paquet-teststs) | Il contient un exemple de code qui teste les typages. Ce code _ne_ s'exécute pas, mais il est vérifié. | -| [`tsconfig.json`](#tsconfigjson) | Cela vous permet d'exécuter `tsc` à l'intérieur du paquet. | -| [`.eslintrc.json`](#linter-eslintrcjson) | (Rarement) Nécessaire uniquement pour désactiver les règles de lint écrites pour eslint. | +| Fichier | Objectif | +| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `index.d.ts` | Il contient les typages du package. | +| [`-tests.ts`](#mon-package-teststs) | Il contient un exemple de code qui teste les typages. Ce code _ne_ s'exécute pas, mais il est vérifié. | +| [`tsconfig.json`](#tsconfigjson) | Cela vous permet d'exécuter `tsc` à l'intérieur du package. | +| [`.eslintrc.json`](#linter-eslintrcjson) | (Rarement) Nécessaire uniquement pour désactiver les règles de lint écrites pour eslint. | +| [`package.json`](#packagejson) | Contient les métadonnées du package, y compris son nom, sa version et ses dépendances. | +| [`.npmignore`](#npmignore) | Spécifie quels fichiers doivent être inclus dans le package. | -Vous pouvez les générer en lançant `npx dts-gen --dt --name --template module` si vous avez npm ≥ 5.2.0, `npm install -g dts-gen` et `dts-gen --dt --name --template module` dans le cas contraire. -Voir toutes les options à [dts-gen](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/dts-gen). +Vous pouvez les générer en lançant `npx dts-gen --dt --name --template module`. +Voir toutes les options sur [dts-gen](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/dts-gen). Si vous avez des fichiers `.d.ts` en plus de `index.d.ts`, assurez-vous qu'ils sont référencés soit dans `index.d.ts` soit dans les tests. Les membres de Definitely Typed surveillent régulièrement les nouveaux PRs, bien qu'il faille garder à l'esprit que le nombre d'autres PRs peut ralentir les choses. -Pour un bon exemple de paquet, voir [base64-js](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/base64-js). +Pour un bon exemple de package, voir [base64-js](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/base64-js). -#### Supprimer un paquet +#### Supprimer un package -Lorsqu'un paquet [bundles](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) ses propres types, les types doivent être supprimés de Definitely Typed pour éviter toute confusion. +Lorsqu'un package [bundles](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) à ses propres types, les types doivent être supprimés de Definitely Typed pour éviter toute confusion. -Vous pouvez le supprimer en lançant `npm run not-needed -- []`. +Vous pouvez le supprimer en lançant `npm run not-needed -- []`. -- `` : C'est le nom du répertoire à supprimer. -- `` : Un stub sera publié dans `@types/` avec cette version. Elle doit être supérieure à toute version actuellement publiée, et doit être une version de `` sur npm. -- `` : Nom du paquet npm qui remplace Definitely Typed types. Habituellement, il est identique à ``, dans ce cas vous pouvez l'omettre. +- `` : C'est le nom du répertoire à supprimer. +- `` : Un stub sera publié dans `@types/` avec cette version. Elle doit être supérieure à toute version actuellement publiée, et doit être une version de `` sur npm. +- `` : Nom du package npm qui remplace les types de Definitely Typed. Habituellement, il est identique à ``, dans ce cas vous pouvez l'omettre. -Tous les autres paquets de Definitely Typed qui référencent le paquet supprimé doivent être mis à jour pour référencer les types regroupés. -Vous pouvez obtenir cette liste en regardant les erreurs de `npm run test-all`. -Pour corriger les erreurs, [ajoutez un `package.json`](#packagejson) avec `"dependencies" : { "" : "x.y.z" }`. -Par exemple : +Si un package n'a jamais été sur Definitely Typed, il n'a pas besoin d'être ajouté à `notNeededPackages.json`. -```json -{ - "private": true, - "dependencies": { - "": "^2.6.0" - } -} -``` +#### Exécution des tests -Lorsque vous ajoutez un `package.json` aux dépendances de ``, vous devez également ouvrir une PR pour ajouter `` [à allowedPackageJsonDependencies.txt dans DefinitelyTyped-tools](https://github.com/microsoft/DefinitelyTyped-tools/blob/master/packages/definitions-parser/allowedPackageJsonDependencies.txt). +Testez vos modifications en lançant `npm test ` où `` est le nom de votre package. +Vous devez l'exécuter depuis le répertoire DefinitelyTyped car les `package.json` individuels ne définissent pas de scripts de test. -Si un paquet n'a jamais été sur Definitely Typed, il n'a pas besoin d'être ajouté à `notNeededPackages.json`. +Ce script utilise [dtslint](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/dtslint) pour lancer le compilateur TypeScript sur vos fichiers dts. -#### Exécution des tests +Une fois que tous vos changements sont prêts, lancez `npm run test-all` pour voir comment vos changements affectent les autres modules. -Testez vos modifications en lançant `npm test ` où `` est le nom de votre paquetage. +##### @arethetypeswrong/cli (`attw`) checks -Ce script utilise [dtslint](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/dtslint) pour lancer le compilateur TypeScript sur vos fichiers dts. +dtslint inclut des vérifications de format de module et de configuration `package.json` à partir de [@arethetypeswrong/cli](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/packages/cli). Les vérifications ne s'exécutent que si un package d'implémentation compatible avec SemVer-major peut être trouvé sur npm pour être comparé au package DefinitelyTyped. (Les packages DefinitelyTyped marqués comme `nonNpm` dans leur `package.json` sont ignorés.) -Une fois que tous vos changements sont prêts, utilisez `npm run test-all` pour voir comment vos changements affectent les autres modules. +De nombreux packages échouent actuellement aux vérifications `attw` et doivent être corrigés. Pour nous permettre de progresser de manière incrémentale, les vérifications `attw` échouées ne font pas échouer l'exécution de `dtslint` lorsque le package est listé dans `failingPackages` dans [`attw.json`](./attw.json), mais elles seront toujours signalées dans la sortie de `pnpm test my-package`. Si vous corrigez le package, retirez-le de `failingPackages` afin que les vérifications `attw` puissent commencer à faire échouer les exécutions de `dtslint`. -#### Nommer +Tous les problèmes signalés par `attw` ont une documentation liée dans la sortie. Voici quelques règles générales pour éviter les problèmes : -Si vous ajoutez des typages pour un paquetage npm, créez un répertoire portant le même nom. -Si le paquet pour lequel vous ajoutez des typages n'est pas sur npm, assurez-vous que le nom que vous choisissez pour lui n'entre pas en conflit avec le nom d'un paquet sur npm. -(Vous pouvez utiliser `npm info ` pour vérifier l'existence du paquet ``). +- Le `package.json` dans le package DefinitelyTyped doit avoir des champs `type` et `exports` correspondants si le package d'implémentation les utilise dans son `package.json`. Par exemple, si un `package.json` d'implémentation ressemble à : -Si un paquet non-npm entre en conflit avec un paquet npm existant, essayez d'ajouter -browser à la fin du nom pour obtenir `-browser`. + ```json + { + "name": "my-package", + "version": "1.0.1", + "type": "module", + "main": "dist/cjs/index.cjs", + "exports": { + ".": { + "import": "./dist/esm/index.js", + "require": "./dist/cjs/index.cjs" + }, + "./subpath": { + "import": "./dist/esm/subpath.js", + "require": "./dist/cjs/subpath.cjs" + } + } + } + ``` -#### `-tests.ts` + alors le `package.json` dans DefinitelyTyped devrait ressembler à ceci : + + ```json5 + { + "name": "@types/my-package", + "version": "1.0.9999", + "type": "module", + "types": "index.d.ts", + "exports": { + ".": { + "import": "./index.d.ts", + "require": "./index.d.cts" + }, + "./subpath": { + "import": "./subpath.d.ts", + "require": "./subpath.d.cts" + } + } + } + ``` -Il devrait y avoir un fichier `-tests.ts`, qui est considéré comme votre fichier de test, avec tous les fichiers `*.ts` qu'il importe. -Si vous ne voyez aucun fichier de test dans le dossier du module, créez un fichier `-tests.ts`. -Ces fichiers sont utilisés pour valider l'API exportée depuis les fichiers `*.d.ts` qui sont livrés en tant que `@types/`. + Notez que chaque sous-chemin `exports` est reflété, et chaque fichier JavaScript a un fichier de déclaration correspondant avec une extension de fichier correspondante à un fichier `.d.ts` d'un fichier `.js`, et non un fichier `.mjs` ou `.cjs` ! -Les changements apportés aux fichiers `*.d.ts` doivent inclure un changement correspondant au fichier `*.ts` qui montre l'API utilisée, afin que quelqu'un ne casse pas accidentellement le code dont vous dépendez. -Si vous ne voyez aucun fichier de test dans le dossier du module, créez un fichier `-tests.ts` +- Lorsque le package d'implémentation utilise `module.exports = ...`, le package DefinitelyTyped doit utiliser `export =`, et non `export default`. (Alternativement, si le `module.exports` est juste un objet de propriétés nommées, le package DefinitelyTyped peut utiliser une série d'exports nommés.) L'obstacle le plus courant pour corriger ce problème est la confusion sur la façon d'exporter des types en plus de l'exportation principale. Par exemple, supposons que ces types utilisent incorrectement `export default` : + + ```ts + export interface Options { + // ... + } + export default function doSomething(options: Options): void; + ``` + + Changer `export default` en `export =` crée une erreur : + ```ts + export interface Options { + // ... + } + declare function doSomething(options: Options): void; + export = doSomething; + // ^^^^^^^^^^^^^^^^^ + // Error: An export assignment cannot be used in a module with other exported elements. + ``` + + Pour résoudre cela, déplacez les types à l'intérieur d'un namespace portant le même nom que la fonction : + + ```ts + declare namespace doSomething { + export interface Options { + // ... + } + } + declare function doSomething(options: doSomething.Options): void; + export = doSomething; + ``` + +Si vous avez besoin d'aide pour résoudre un problème, veuillez demander dans le canal DefinitelyTyped sur le [serveur Discord de la communauté TypeScript](https://discord.gg/typescript). + +#### Nommage + +Si vous ajoutez des types pour un package npm, créez un répertoire portant le même nom. +Si le package pour lequel vous ajoutez des types n'est pas sur npm, assurez-vous que le nom que vous choisissez pour lui n'entre pas en conflit avec le nom d'un package sur npm. +(Vous pouvez utiliser `npm info ` pour vérifier l'existence du package ``). + +Dans de rares occasions, `nonNpm` peut être défini sur `"conflict"`, ce qui indique qu'il existe un package sur npm avec le même nom, mais que les types sont intentionnellement en conflit avec ce package. +Cela peut être vrai pour les packages qui définissent un environnement comme `@types/node` ou pour des packages factices comme `aws-lambda`. Évitez d'utiliser `"conflict"` autant que possible. + +#### `-tests.ts` + +Il devrait y avoir un fichier `-tests.ts`, qui est considéré comme votre fichier de test, avec tous les fichiers `*.ts` qu'il importe. +Si vous ne voyez aucun fichier de test dans le dossier du module, créez un fichier `-tests.ts`. +Ces fichiers sont utilisés pour valider l'API exportée depuis les fichiers `*.d.ts` qui sont livrés en tant que `@types/`. +Ils ne sont pas eux-mêmes expédiés. + +Les changements apportés aux fichiers `*.d.ts` doivent inclure un changement correspondant au fichier `*.ts` qui montre l'API utilisée, afin que quelqu'un ne casse pas accidentellement le code dont vous dépendez. Par exemple, cette modification d'une fonction dans un fichier `.d.ts` ajoute un nouveau paramètre à une fonction : `index.d.ts`: @@ -246,7 +338,7 @@ Par exemple, cette modification d'une fonction dans un fichier `.d.ts` ajoute un + export function twoslash(body: string, config?: { version: string }): string ``` -`-tests.ts`: +`-tests.ts`: ```diff import {twoslash} from "./" @@ -263,7 +355,7 @@ const result = twoslash("//") Si vous vous demandez par où commencer avec le code de test, les exemples dans le README du module sont un bon point de départ. -Vous pouvez [valider vos changements](#exécution-des-tests) avec `npm test ` depuis la racine de ce repo, qui prend en compte les fichiers modifiés. +Vous pouvez [valider vos changements](#exécution-des-tests) avec `npm test ` depuis la racine de ce repo, qui prend en compte les fichiers modifiés. Utilisez `$ExpectType` pour affirmer qu'une expression est d'un type donné, et `@ts-expect-error` pour affirmer qu'il s'agit d'une erreur de compilation. Exemples : @@ -279,7 +371,7 @@ Pour plus de détails, voir le readme de [dtslint](https://github.com/Microsoft/ ##### Linter: `.eslintrc.json` -Vous devez désactiver des règles spécifiques uniquement sur des lignes spécifiques : +Si, pour une raison quelconque, une règle de lint doit être désactivée, désactivez-la pour une ligne spécifique : ```ts // eslint-disable-next-line no-const-enum @@ -291,11 +383,12 @@ const enum Enum { // eslint-disable-line no-const-enum } ``` -Vous pouvez toujours désactiver les règles avec un fichier .eslintrc.json, mais vous ne devriez pas le faire dans les nouveaux paquets. +Vous pouvez toujours désactiver les règles avec un fichier `.eslintrc.json`, mais vous ne devriez pas le faire dans les nouveaux packages. +Désactiver les règles pour l'ensemble du package rend la révision plus difficile. #### `tsconfig.json` -`tsconfig.json` doit avoir `noImplicitAny`, `noImplicitThis`, `strictNullChecks`, et `strictFunctionTypes` mis à `true`. +`tsconfig.json` doit avoir `noImplicitAny`, `noImplicitThis`, `strictNullChecks`, et `strictFunctionTypes` défini à `true`. Vous pouvez éditer le fichier `tsconfig.json` pour ajouter de nouveaux fichiers de test, pour ajouter `"target" : "es6"` (nécessaire pour les fonctions asynchrones), pour ajouter à `"lib"`, ou pour ajouter l'option de compilateur `"jsx"`. @@ -316,7 +409,7 @@ TL;DR : `esModuleInterop` et `allowSyntheticDefaultImports` ne sont _pas autoris > import Component from "./component"; > ``` > -> Puisque la validité à la compilation de l'import dans `dex.d.ts` dépend de paramètres de compilation spécifiques, dont les utilisateurs de vos types n'héritent pas, l'utilisation de ce pattern dans DefinitelyTyped forcerait les utilisateurs à changer leurs propres paramètres de compilation, ce qui pourrait être incorrect pour leur environnement d'exécution. Au lieu de cela, vous devez écrire un import CJS pour un export CJS afin d'assurer une compatibilité généralisée et indépendante de la configuration : +> Puisque la validité à la compilation de l'import dans `index.d.ts` dépend de paramètres de compilation spécifiques, dont les utilisateurs de vos types n'héritent pas, l'utilisation de ce pattern dans DefinitelyTyped forcerait les utilisateurs à changer leurs propres paramètres de compilation, ce qui pourrait être incorrect pour leur environnement d'exécution. Au lieu de cela, vous devez écrire un import CJS pour un export CJS afin d'assurer une compatibilité généralisée et indépendante de la configuration : > > ```ts > // index.d.ts @@ -326,65 +419,125 @@ TL;DR : `esModuleInterop` et `allowSyntheticDefaultImports` ne sont _pas autoris #### `package.json` -En général, vous n'en aurez pas besoin. -L'éditeur de paquets de DefinitelyTyped crée un `package.json` pour les paquets qui n'ont pas de dépendances en dehors de DefinitelyTyped. -Un `package.json` peut être inclus pour spécifier des dépendances qui ne sont pas d'autres paquets `@types`. -[Pikaday en est un bon exemple](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/pikaday/package.json) -Même si vous écrivez votre propre `package.json`, vous ne pouvez spécifier que des dépendances ; d'autres champs comme `"description"` ne sont pas autorisés. -Vous devez également ajouter la dépendance à [la liste des paquets autorisés](https://github.com/microsoft/DefinitelyTyped-tools/blob/master/packages/definitions-parser/allowedPackageJsonDependencies.txt). -Cette liste est mise à jour par un humain, ce qui nous permet de nous assurer que les paquets `@types` ne dépendent pas de paquets malveillants. +Ce fichier est requis et doit suivre ce modèle : -Dans le rare cas où un paquet `@types` est supprimé et retiré en faveur des types fournis par le paquet source ET que vous avez besoin de dépendre de l'ancien paquet `@types` retiré, vous pouvez ajouter une dépendance sur un paquet `@types`. -Assurez-vous d'expliquer cela lors de l'ajout à la liste des paquets autorisés afin que le mainteneur humain sache ce qui se passe. +```json5 +{ + "private": true, + "name": "@types/PACKAGE-NAME", + "version": "1.2.9999", + "projects": [ + "https://aframe.io/" + ], + "dependencies": { + "@types/DEPENDENCY-1": "*", + "@types/DEPENDENCY-2": "*" + }, + "devDependencies": { + "@types/PACKAGE-NAME": "workspace:." + }, + "owners": [ + { + "name": "Your Name Here", + "githubUsername": "ghost" + } + ] +} +``` -La deuxième raison de créer votre propre package.json est de spécifier les modules ES. -Si le paquet d'implémentation utilise ESM et spécifie `"type" : "module"`, alors vous devez ajouter un package.json avec la même chose : +Un `package.json` spécifie _toutes_ les dépendances, y compris les autres packages `@types`. + +Vous devez ajouter les dépendances non-`@types` à [la liste des dépendances externes autorisées](https://github.com/microsoft/DefinitelyTyped-tools/blob/master/packages/definitions-parser/allowedPackageJsonDependencies.txt). +[Pikaday est un bon exemple.](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/pikaday/package.json) +Ces ajouts sont approuvés par un mainteneur, ce qui nous donne l'occasion de nous assurer que les packages `@types` ne dépendent pas de packages malveillants. + +Si le package d'implémentation utilise ESM et spécifie `"type" : "module"`, alors vous devez ajouter un package.json avec la même chose : ```json { - "private": true, "type": "module" } ``` -Ceci s'applique également si le paquet d'implémentation a `exports` dans son package.json. +Ceci s'applique également si le package d'implémentation a `exports` dans son package.json. -#### `OTHER_FILES.txt` +##### Peer dependencies -Si un fichier n'est ni testé ni référencé dans `index.d.ts`, ajoutez-le à un fichier nommé `OTHER_FILES.txt`. Ce fichier est une liste d'autres fichiers qui doivent être inclus dans le paquetage typings, un fichier par ligne. +Definitely Typed autorise les `peerDependencies` dans `package.json`. +Les peer dependencies peuvent aider à prévenir les situations où un gestionnaire de package installe de manière inattendue des versions trop récentes ou plusieurs versions du même package. +Cependant, les peer dependencies ont des inconvénients ; les gestionnaires de packages diffèrent dans leur gestion des peer dependencies (par exemple, `yarn` ne les installe pas automatiquement, `npm` nécessite `--legacy-peer-deps` pour les incompatibilités). +Ainsi, les PR introduisant de nouvelles peer dependencies nécessitent l'approbation d'un mainteneur et doivent être limitées à des circonstances spécifiques. + +**En général, les packages de types ne devraient avoir une peer dependency que si le package en amont a une peer dependency sur le même package (ou ses types).** +Par exemple, un package DT pour un composant React peut spécifier une peer dependency sur `@types/react@*`, car le consommateur aura besoin d'installer `@types/react` pour utiliser JSX en premier lieu. +Si le consommateur installe `@types/react@16` dans son projet, mais qu'une version plus récente de `@types/react` est disponible sur npm, la peer dependency peut aider le gestionnaire de packages à choisir `@types/react@16` au lieu de cette version plus récente. +De même, `chai-as-promised` a une peer dependency sur `chai`, donc `@types/chai-as-promised` devrait avoir une peer dependency sur `@types/chai`. + +Il existe certains cas où le package en amont n'a pas de peer dependency sur le package de types, mais une peer dependency est toujours appropriée. +Ce sont généralement des cas où le package en amont étend un autre package et suppose qu'il existe, donc _devrait_ avoir déclaré une peer dependency car il étend un autre package, mais ne l'a pas fait. +Par exemple, `chai-match-pattern` étend `chai`, mais ne déclare pas de peer dependency sur `chai`, mais en a besoin pour fonctionner. `@types/chai-match-pattern` devrait avoir une peer dependency sur `@types/chai`. + +Si un package expose simplement des types d'un autre package dans le cadre de son API en raison d'une dépendance régulière dans le package en amont, il _ne devrait pas_ utiliser une peer dependency. +Par exemple, `express` a `qs` dans ses `"dependencies"`. Lorsque les utilisateurs installent `express`, ils n'ont pas besoin d'installer manuellement `qs`. De même, `@types/express` a `@types/qs` dans ses `"dependencies"`. +Il serait incorrect de déclarer `@types/qs` comme une peer dependency de `@types/express`, car cela obligerait certains consommateurs en aval à installer manuellement `@types/qs`. + +#### `.npmignore` + +Ce fichier définit quels fichiers doivent être inclus dans chaque package `@types`. Il doit prendre une forme spécifique. Pour les packages avec une seule version dans le dépôt : + +```ignore +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts +``` + +Ce qui signifie "ignorer tous les fichiers, mais ne pas ignorer les fichiers de déclaration". Pour les packages qui ont plus d'une version dans le dépôt, la version "la plus récente" (au niveau supérieur) devrait contenir quelque chose comme : + +```ignore +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts +/v15/ +/v16/ +/v17/ +``` + +Ce qui est identique au précédent `.npmignore` mais en ignorant chaque répertoire enfant versionné. + +La CI échouera si ce fichier contient des contenus incorrects et fournira la valeur attendue. Peu importe ce que contient ce fichier, le publisher ne publiera que les fichiers de déclaration. #### Erreurs courantes - Tout d'abord, suivez les conseils du [manuel](https://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html). -- Formatage : Utilisez 4 espaces. Prettier est installé sur ce repo, vous pouvez donc lancer `npm run prettier -- --write 'path/to/package/**/*.ts'`. [Lorsque vous utilisez des assertions](https://github.com/SamVerschueren/tsd#assertions), ajoutez l'exclusion `// prettier-ignore` pour marquer les lignes de code comme exclues du formatage : - ```tsx - // prettier-ignore - // @ts-expect-error - const incompleteThemeColorModes: Theme = { colors: { modes: { papaya: { - ``` -- `function sum(nums : number[]) : number` : Utilisez `ReadonlyArray` si une fonction n'écrit pas dans ses paramètres. +- Formatage : [dprint](https://dprint.dev) est configuré sur ce dépôt, vous pouvez donc lancer `pnpm dprint fmt -- 'path/to/package/**/*.ts'`. + - Envisagez d'utiliser le fichier `.vscode/settings.template.json` de VS Code (ou l'équivalent pour d'autres éditeurs) pour formater à la sauvegarde avec l'[extension dprint pour VS Code](https://marketplace.visualstudio.com/items?itemName=dprint.dprint). +- `function sum(nums: number[]): number`: Utilisez `ReadonlyArray` si une fonction n'écrit pas dans ses paramètres. - `interface Foo { new(): Foo; }`: - Cela définit un type d'objets qui peuvent être modifiés. Vous voudrez probablement `declare class Foo { constructor() ; }`. + Cela définit un type d'objets qui peuvent être modifiés. Vous voudrez probablement `declare class Foo { constructor(); }`. - `const Class: { new(): IClass; }`: - Il est préférable d'utiliser une déclaration de classe `class Class { constructor() ; }` plutôt qu'une constante modifiable. + Il est préférable d'utiliser une déclaration de classe `class Class { constructor(); }` plutôt qu'une constante modifiable. - `getMeAT(): T`: Si un paramètre de type n'apparaît dans les types d'aucun paramètre, il ne s'agit pas vraiment d'une fonction générique, mais simplement d'une assertion de type déguisée. - Il est préférable d'utiliser une assertion de type réel, par exemple `getMeAT() as number`. - Exemple où un paramètre de type est acceptable : `function id(value : T) : T;`. - Exemple où il n'est pas acceptable : `function parseJson(json : string) : T;`. + Il est préférable d'utiliser une assertion de type réelle, par exemple `getMeAT() as number`. + Exemple où un paramètre de type est acceptable : `function id(value: T): T;`. + Exemple où il n'est pas acceptable : `function parseJson(json: string): T;`. Exception : `new Map()` est OK. -- L'utilisation des types `Function` et `Object` n'est presque jamais une bonne idée. Dans 99% des cas, il est possible de spécifier un type plus spécifique. Les exemples sont `(x : number) => number` pour les [fonctions](https://www.typescriptlang.org/docs/handbook/2/functions.html#function-type-expressions) et `{ x : number, y : number }` pour les objets. S'il n'y a aucune certitude sur le type, [`any`](https://www.typescriptlang.org/docs/handbook/basic-types.html#any) est le bon choix, pas `Object`. Si la seule chose connue à propos du type est qu'il s'agit d'un objet, utilisez le type [`object`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#object-type), pas `Object` ou `{ [key : string] : any }`. +- L'utilisation des types `Function` et `Object` n'est presque jamais une bonne idée. Dans 99% des cas, il est possible de spécifier un type plus spécifique. Les exemples sont `(x: number) => number` pour les [fonctions](https://www.typescriptlang.org/docs/handbook/2/functions.html#function-type-expressions) et `{ x: number, y: number }` pour les objets. S'il n'y a aucune certitude sur le type, [`any`](https://www.typescriptlang.org/docs/handbook/basic-types.html#any) est le bon choix, pas `Object`. Si la seule chose connue à propos du type est qu'il s'agit d'un objet, utilisez le type [`object`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#object-type), pas `Object` ou `{ [key: string]: any }`. - `var foo: string | any`: Lorsque `any` est utilisé dans un type union, le type résultant est toujours `any`. Ainsi, bien que la partie `string` de cette annotation de type puisse _look_ utile, elle n'offre en fait aucune vérification de type supplémentaire par rapport à l'utilisation simple de `any`. Selon l'intention, les alternatives acceptables pourraient être `any`, `string`, ou `string | object`. -### Définition des propriétaires +### Propriétaires de définition > TL;DR : ne pas modifier `.github/CODEOWNERS`, toujours modifier la liste des propriétaires dans `package.json`. DT a le concept de "propriétaires de définition" qui sont des personnes qui veulent maintenir la qualité des types d'un module particulier. -- En vous ajoutant à la liste, vous serez notifié (via votre nom d'utilisateur GitHub) chaque fois que quelqu'un fera une pull request ou une issue concernant le paquet. +- En vous ajoutant à la liste, vous serez notifié (via votre nom d'utilisateur GitHub) chaque fois que quelqu'un fera une pull request ou une issue concernant le package. - Vos reviews de PR auront une plus grande importance pour [le bot](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot) qui maintient ce repo. - Les mainteneurs de DT font confiance aux propriétaires des définitions pour assurer un écosystème stable, ne vous ajoutez pas à la légère. @@ -413,7 +566,7 @@ Definitely Typed est l'un des dépôts les plus actifs sur GitHub. Vous vous êt ## FAQ -#### Quelle est la relation exacte entre ce dépôt et les paquets `@types` sur npm ? +#### Quelle est la relation exacte entre ce dépôt et les packages `@types` sur npm ? La branche `master` est automatiquement publiée dans le scope `@types` sur npm grâce à [DefinitelyTyped-tools](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/publisher). @@ -434,22 +587,31 @@ Les modifications apportées à ces projets peuvent avoir des effets considérab Ces modules requièrent à la fois l'approbation d'un mainteneur de DT et le soutien enthousiaste des propriétaires du module. La barre pour réussir cela peut être assez haute, et souvent les PRs peuvent s'essouffler parce qu'il n'y a pas de champion. Si vous constatez que personne ne s'engage, essayez de réduire la portée de votre PR. -#### Mon PR est fusionné ; quand le paquet npm `@types` sera-t-il mis à jour ? +#### Mon PR est fusionné ; quand le package npm `@types` sera-t-il mis à jour ? -Les paquets npm devraient être mis à jour dans les minutes qui suivent. Si cela fait plus d'une heure, mentionnez le numéro de PR sur [le canal Definitely Typed sur le serveur Discord de la communauté TypeScript](https://discord.gg/typescript) et le mainteneur actuel demandera au bon membre de l'équipe d'enquêter. +Les packages npm devraient être mis à jour dans les minutes qui suivent. Si cela fait plus d'une heure, mentionnez le numéro de PR sur [le canal Definitely Typed sur le serveur Discord de la communauté TypeScript](https://discord.gg/typescript) et le mainteneur actuel demandera au bon membre de l'équipe d'enquêter. #### J'écris une définition qui dépend d'une autre définition. Dois-je utiliser `` ou un import ? Si le module auquel vous faites référence est un module externe (qui utilise `export`), utilisez un import. Si le module auquel vous faites référence est un module ambiant (qui utilise `declare module`, ou qui déclare simplement des globaux), utilisez ``. -#### Certains paquets n'ont pas de `tslint.json`, et certains `tsconfig.json` n'ont pas `"noImplicitAny" : true`, `"noImplicitThis" : true`, ou `"strictNullChecks" : true`. +#### Certains packages n'ont pas de `tslint.json`, et certains `tsconfig.json` n'ont pas `"noImplicitAny" : true`, `"noImplicitThis" : true`, ou `"strictNullChecks" : true`. Alors ils sont faux, et nous ne l'avons pas encore remarqué. Vous pouvez nous aider en soumettant une demande d'extraction pour les corriger. -#### Puis-je modifier/renforcer les paramètres de formatage des modules ? +#### Les fichiers sont-ils formatés automatiquement ? -Non. Nous avons déjà essayé de rendre le formatage du code de DT cohérent, mais nous sommes arrivés à une impasse en raison de la forte activité sur le repo. Nous incluons les paramètres de formatage via [`.editorconfig`](.editorconfig). Ceux-ci sont exclusivement destinés à l'outillage de votre éditeur, leurs paramètres n'entrent pas en conflit et nous ne prévoyons pas de les modifier. Nous ne prévoyons pas non plus d'imposer un style spécifique dans le repo. Nous voulons garder les barrières aux contributions basses. +Oui, en utilisant [dprint](https://dprint.dev). +Nous recommandons d'utiliser une [extension dprint pour votre éditeur](https://dprint.dev/install/#editor-extensions). + +Alternativement, vous pouvez activer un hook git qui formatera automatiquement votre code. Exécutez `pnpm run setup-hooks`. Ensuite, lorsque vous committez, la commande `dprint fmt` sera exécutée sur les fichiers modifiés. Si vous utilisez le [clone partiel](#partial-clone), assurez-vous d'appeler `git sparse-checkout add .husky` pour vérifier les hooks git avant d'exécuter le script `setup-hooks`. + +Les pull requests n'ont pas besoin d'un formatage correct pour être fusionnées. +Tout code non formaté sera automatiquement reformaté après avoir été fusionné. + +> 💡 Si vous utilisez VS Code, nous vous suggérons de copier le fichier `.vscode/settings.template.json` vers `.vscode/settings.json`. +> Ce modèle définit l'[extension dprint pour VS Code](https://marketplace.visualstudio.com/items?itemName=dprint.dprint) comme le formateur par défaut dans le dépôt. #### Puis-je demander une définition ? @@ -459,19 +621,19 @@ Voici les [définitions actuellement demandées](https://github.com/DefinitelyTy Si les types font partie d'un standard web, ils doivent être ajoutés à [TypeScript-DOM-lib-generator](https://github.com/Microsoft/TypeScript-DOM-lib-generator) afin qu'ils puissent faire partie de la `lib.dom.d.ts` par défaut. -#### Qu'en est-il des définitions de type sans paquet correspondant ? +#### Qu'en est-il des définitions de type sans package correspondant ? S'il n'y a pas de code Javascript source du tout, par exemple si vous écrivez des types d'aide ou des types pour une spécification, vous devriez publier les types vous-même, pas sur Definitely Typed. -Parce qu'ils sont destinés à fournir des types pour du code Javascript existant, les paquets `@types` ne sont pas destinés à être importés directement. -En d'autres termes, vous ne devriez pas créer un paquet Definitely Typed destiné à être utilisé comme `import type { ... } from "@types/foo"`. +Parce qu'ils sont destinés à fournir des types pour du code Javascript existant, les packages `@types` ne sont pas destinés à être importés directement. +En d'autres termes, vous ne devriez pas créer un package Definitely Typed destiné à être utilisé comme `import type { ... } from "@types/foo"`. Vous ne devez pas non plus vous attendre à écrire `import type { ... } from "foo"` quand il n'y a pas de `foo` installé. C'est différent de fournir des types pour une bibliothèque Javascript uniquement pour le navigateur ou des types pour un environnement entier comme node, bun, et al. Là, les types sont résolus soit implicitement, soit en utilisant `/// `. -#### Dois-je ajouter un espace de noms vide à un paquetage qui n'exporte pas de module pour utiliser les importations de style ES6 ?? +#### Dois-je ajouter un espace de noms vide à un package qui n'exporte pas de module pour utiliser les importations de style ES6 ?? -Certains paquets, comme [chai-http](https://github.com/chaijs/chai-http), exportent une fonction. +Certains packages, comme [chai-http](https://github.com/chaijs/chai-http), exportent une fonction. Importer ce module avec un import de style ES6 de la forme `import * as foo from "foo";` conduit à l'erreur : @@ -486,14 +648,14 @@ Néanmoins, si vous voulez utiliser un import par défaut comme `import foo from - vous pouvez utiliser l'option de compilation [`--allowSyntheticDefaultImports`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-1-8.html#support-for-default-import-interop-with-systemjs) si votre module d'exécution supporte un schéma d'interopérabilité pour les modules non-ECMAScript, c'est-à-dire si les importations par défaut fonctionnent dans votre environnement (par exemple Webpack, SystemJS, esm). - vous pouvez utiliser l'option de compilation [`--esModuleInterop`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#support-for-import-d-from-cjs-form-commonjs-modules-with---esmoduleinterop) si vous voulez que TypeScript prenne en charge l'interopérabilité non-ECMAScript (depuis TypeScript 2.7). -#### Un paquet utilise `export =`, mais je préfère utiliser les importations par défaut. Puis-je remplacer `export =` par `export default` ? +#### Un package utilise `export =`, mais je préfère utiliser les importations par défaut. Puis-je remplacer `export =` par `export default` ? Comme dans la question précédente, il faut utiliser les options [`--allowSyntheticDefaultImports`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-1-8.html#support-for-default-import-interop-with-systemjs) ou [`--esModuleInterop`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#support-for-import-d-from-cjs-form-commonjs-modules-with---esmoduleinterop) du compilateur. Ne changez pas la définition du type si elle est correcte. -Pour un paquet npm, `export =` est correct si `node -p 'require("foo")'` fonctionne pour importer un module, et `export default` est correct si `node -p 'require("foo").default'` fonctionne pour importer un module. +Pour un package npm, `export =` est correct si `node -p 'require("foo")'` fonctionne pour importer un module, et `export default` est correct si `node -p 'require("foo").default'` fonctionne pour importer un module. #### Je souhaite utiliser les fonctionnalités des toutes nouvelles versions de TypeScript. @@ -504,7 +666,7 @@ Vous trouverez une explication détaillée de cette fonctionnalité dans la [doc Voici un petit exemple pour commencer : -1. Vous devrez ajouter un fichier `package.json` à votre définition de paquet, avec le contenu suivant : +1. Vous devrez ajouter `typesVersions` au `package.json` : ```json { @@ -517,112 +679,101 @@ Voici un petit exemple pour commencer : ``` 2. Créez le sous-répertoire mentionné dans le champ `typesVersions` à l'intérieur de votre répertoire de types (`ts3.6/` dans cet exemple). - `ts3.6/` supportera les versions 3.6 et inférieures de TypeScript, donc copiez les types et les tests existants dans ce répertoire. - - Vous devrez supprimer l'en-tête de définition de `ts3.6/index.d.ts` puisque seule la racine `index.d.ts` est supposée l'avoir. - -3. Définissez les options `baseUrl` et `typeRoots` dans `ts3.6/tsconfig.json` avec les chemins corrects, qui devraient ressembler à ceci : - ```json - { - "compilerOptions": { - "baseUrl": "../../", - "typeRoots": ["../../"] - } - } - ``` + `ts3.6/` supportera les versions de TypeScript 3.6 et inférieures, alors copiez-y les types et tests existants. -4. À la racine du paquet, ajoutez les fonctionnalités TypeScript 3.7 que vous souhaitez utiliser. - Lors de l'installation du paquet, TypeScript 3.6 et moins démarrera à partir de `ts3.6/index.d.ts`, tandis que TypeScript 3.7 et plus démarrera à partir de `index.d.ts`. +3. De retour à la racine du package, ajoutez les fonctionnalités de TypeScript 3.7 que vous souhaitez utiliser. + Lorsque les gens installeront le package, TypeScript 3.6 et inférieures commenceront à partir de `ts3.6/index.d.ts`, tandis que TypeScript 3.7 et supérieures commenceront à partir de `index.d.ts`. - Vous pouvez prendre l'exemple de [bluebird](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/f2512c2cf7cdcf9a487d989e288174e49b7839ab/types/bluebird). + Vous pouvez consulter [bluebird](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/f2512c2cf7cdcf9a487d989e288174e49b7839ab/types/bluebird) pour un exemple. #### Je souhaite ajouter une API DOM qui n'est pas présente par défaut dans TypeScript. Cela pourrait être dans [TypeScript-DOM-lib-generator](https://github.com/Microsoft/TypeScript-DOM-lib-generator#readme). Voir les lignes directrices à cet endroit. Si le standard est encore à l'état de projet, il a sa place ici. Utilisez un nom commençant par `dom-` et incluez un lien vers le standard comme lien "Project" dans l'en-tête. -Lorsqu'il sort du mode brouillon, nous pouvons le retirer de Definitely Typed et déprécier le paquetage `@types` associé. +Lorsqu'il sort du mode brouillon, nous pouvons le retirer de Definitely Typed et déprécier le packageage `@types` associé. -#### Comment les versions des paquets Definitely Typed sont-elles liées aux versions de la bibliothèque correspondante ? +#### Comment les versions des packages Definitely Typed sont-elles liées aux versions de la bibliothèque correspondante ? _REMARQUE : la discussion dans cette section suppose une certaine familiarité avec le [Semantic versioning](https://semver.org/)_. -Chaque paquet Definitely Typed est versionné lorsqu'il est publié sur npm. -L'outil [DefinitelyTyped-tools](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/publisher) (l'outil qui publie les paquets `@types` sur npm) définira la version du paquet de déclaration en utilisant le numéro de version `major.minor` listé dans la première ligne de son fichier `index.d.ts`. -Par exemple, voici les premières lignes de [Node's type declarations](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/1253faabf5e0d2c5470db6ea87795d7f96fef7e2/types/node/index.d.ts) pour la version `10.12.x` au moment de l'écriture : +Chaque package de Definitely Typed est versionné lorsqu'il est publié sur npm. +L'outil [DefinitelyTyped-tools](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/publisher) (l'outil qui publie les packages `@types` sur npm) définira la version du package de déclaration en utilisant le numéro de version `major.minor.9999` indiqué dans `package.json`. +Par exemple, voici les premières lignes des déclarations de type de Node pour la version `20.8.x` au moment de la rédaction : -```js -// Type definitions for Node.js 10.12 -// Project: https://nodejs.org/ -// Definitions by: Microsoft TypeScript -// Definitely Typed -// Alberto Schiabel +```json +{ + "private": true, + "name": "@types/node", + "version": "20.8.9999" +} ``` -Parce que `10.12` est à la fin de la première ligne, la version npm du paquet `@types/node` sera aussi `10.12.x`. -Notez que le commentaire de la première ligne du fichier `index.d.ts` ne doit contenir que la version `major.minor` (par exemple `10.12`) et ne doit pas contenir de version de correctif (par exemple `10.12.4`). -C'est parce que seuls les numéros de version majeure et mineure sont alignés entre les paquets de bibliothèques et les paquets de déclarations de types. -Le numéro de version du patch du paquet de déclaration de type (par exemple `.0` dans `10.12.0`) est initialisé à zéro par Definitely Typed et est incrémenté à chaque fois qu'un nouveau paquet `@types/node` est publié sur npm pour la même version majeure/mineure de la bibliothèque correspondante. +Comme la version est indiquée comme `20.8.9999`, la version npm du package `@types/node` sera également `20.8.x`. +Notez que la version dans `package.json` ne doit contenir que la version `major.minor` (par exemple `10.12`) suivie de `.9999`. +Cela est dû au fait que seuls les numéros de version majeure et mineure sont alignés entre les packages de bibliothèque et les packages de déclaration de type. (Le `.9999` est utilisé pour s'assurer que les packages locaux `@types` sont toujours les plus récents pendant le développement local.) +Le numéro de version patch du package de déclaration de type (par exemple `.0` dans `20.8.0`) est initialisé à zéro par Definitely Typed et est incrémenté chaque fois qu'un nouveau package `@types/node` est publié sur npm pour la même version majeure/mineure de la bibliothèque correspondante. -Il arrive que les versions des paquets de déclarations de type et les versions des paquets de bibliothèques ne soient pas synchronisées. -Voici quelques raisons courantes, classées par ordre de gêne pour les utilisateurs d'une bibliothèque. +Parfois, les versions des packages de déclaration de type et des packages de bibliothèque peuvent être désynchronisées. +Voici quelques raisons courantes pour lesquelles cela peut se produire, classées par ordre de gêne pour les utilisateurs d'une bibliothèque. Seul le dernier cas est généralement problématique. -- Comme indiqué ci-dessus, la version du patch du paquet de déclaration de type n'est pas liée à la version du patch de la bibliothèque. - Cela permet à Definitely Typed de mettre à jour en toute sécurité les déclarations de types pour la même version majeure/mineure d'une bibliothèque. -- Si vous mettez à jour un paquet pour une nouvelle fonctionnalité, n'oubliez pas de mettre à jour le numéro de version pour qu'il corresponde à la version de la bibliothèque. - Si les utilisateurs s'assurent que les versions correspondent entre les paquets JavaScript et leurs paquets `@types` respectifs, alors `npm update` devrait fonctionner. -- Il est fréquent que les mises à jour des paquets de déclarations de types soient en retard par rapport aux mises à jour des bibliothèques, car ce sont souvent les utilisateurs des bibliothèques, et non les mainteneurs, qui mettent à jour Definitely Typed lorsque de nouvelles fonctionnalités des bibliothèques sont publiées. - Il peut donc y avoir un décalage de plusieurs jours, semaines ou même mois avant qu'un membre utile de la communauté n'envoie un PR pour mettre à jour le paquet de déclaration de type pour une nouvelle version de la bibliothèque. - Si vous êtes affecté par cela, vous pouvez être le changement que vous voulez voir dans le monde et vous pouvez être ce membre utile de la communauté ! +- Comme indiqué ci-dessus, la version patch du package de déclaration de type est indépendante de la version patch de la bibliothèque. + Cela permet à Definitely Typed de mettre à jour en toute sécurité les déclarations de type pour la même version majeure/mineure d'une bibliothèque. +- Si vous mettez à jour un package pour de nouvelles fonctionnalités, n'oubliez pas de mettre à jour le numéro de version pour qu'il corresponde à cette version de la bibliothèque. + Si les utilisateurs s'assurent que les versions correspondent entre les packages JavaScript et leurs packages `@types` respectifs, alors `npm update` devrait généralement fonctionner correctement. +- Il est courant que les mises à jour des packages de déclaration de type soient en retard par rapport aux mises à jour des bibliothèques, car ce sont souvent les utilisateurs des bibliothèques, et non les mainteneurs, qui mettent à jour Definitely Typed lorsque de nouvelles fonctionnalités de bibliothèque sont publiées. + Il peut donc y avoir un décalage de quelques jours, semaines ou même mois avant qu'un membre de la communauté n'envoie une PR pour mettre à jour le package de déclaration de type pour une nouvelle version de la bibliothèque. + Si cela vous impacte, vous pouvez être le changement que vous voulez voir dans le monde et être ce membre de la communauté utile ! -:exclamation: Si vous mettez à jour les déclarations de type pour une bibliothèque, mettez toujours la version `major.minor` dans la première ligne de `index.d.ts` pour qu'elle corresponde à la version de la bibliothèque que vous documentez ! :exclamation: +:exclamation: Si vous mettez à jour les déclarations de type pour une bibliothèque, définissez toujours la version `major.minor` dans `package.json` pour qu'elle corresponde à la version de la bibliothèque que vous documentez ! :exclamation: -#### Si une bibliothèque est mise à jour vers une nouvelle version majeure comportant des changements importants, comment dois-je mettre à jour son paquet de déclarations de types ? +#### Si une bibliothèque est mise à jour vers une nouvelle version majeure comportant des changements importants, comment dois-je mettre à jour son package de déclarations de types ? -Le [Semantic versioning](https://semver.org/) requiert que les versions avec des changements importants doivent incrémenter le numéro de la version majeure. -Par exemple, une bibliothèque qui supprime une fonction exportée publiquement après sa version `3.5.8` doit augmenter sa version à `4.0.0` dans sa prochaine version. -De plus, lorsque la version `4.0.0` de la bibliothèque est sortie, son paquet Definitely Typed Type Declaration doit aussi être mis à jour en `4.0.0`, en incluant tous leschangements importants dans l'API de la bibliothèque. +[La gestion sémantique des versions](https://semver.org/) exige que les versions avec des changements majeurs doivent incrémenter le numéro de version majeure. +Par exemple, une bibliothèque qui supprime une fonction exportée publiquement après sa version `3.5.8` doit passer à la version `4.0.0` lors de sa prochaine publication. +De plus, lorsque la version `4.0.0` de la bibliothèque est publiée, le package de déclarations de type Definitely Typed doit également être mis à jour à `4.0.0`, y compris tous les changements majeurs de l'API de la bibliothèque. -De nombreuses bibliothèques disposent d'une large base installée de développeurs (y compris les responsables d'autres paquets utilisant cette bibliothèque comme dépendance) qui ne passeront pas immédiatement à une nouvelle version comportant des changements radicaux, car il peut s'écouler des mois avant qu'un responsable n'ait le temps de réécrire le code pour l'adapter à la nouvelle version. -En attendant, les utilisateurs des anciennes versions de la bibliothèque peuvent toujours vouloir mettre à jour les déclarations de type pour les anciennes versions. +De nombreuses bibliothèques ont une grande base d'utilisateurs (y compris les mainteneurs d'autres packages utilisant cette bibliothèque comme dépendance) qui ne passeront pas immédiatement à une nouvelle version avec des changements majeurs, car il peut s'écouler des mois avant qu'un mainteneur ait le temps de réécrire le code pour s'adapter à la nouvelle version. +En attendant, les utilisateurs des anciennes versions de la bibliothèque peuvent toujours vouloir mettre à jour les déclarations de type pour les versions plus anciennes. -Si vous avez l'intention de continuer à mettre à jour l'ancienne version des déclarations de types d'une bibliothèque, vous pouvez créer un nouveau sous-dossier (par exemple `/v2/`) nommé pour la version actuelle (bientôt "ancienne"), et copier les fichiers existants de la version actuelle dans ce sous-dossier. +Si vous avez l'intention de continuer à mettre à jour les déclarations de type de l'ancienne version d'une bibliothèque, vous pouvez créer un nouveau sous-dossier (par exemple `/v2/`) nommé d'après la version actuelle (bientôt "ancienne") et y copier les fichiers existants de la version actuelle. -Comme le dossier racine doit toujours contenir les déclarations de type de la dernière ("nouvelle") version, vous devrez apporter quelques modifications aux fichiers de votre sous-répertoire de l'ancienne version pour vous assurer que les références de chemin relatif pointent vers le sous-répertoire, et non vers la racine. +Lors de la création d'un nouveau dossier de version, assurez-vous que le champ version de `package.json` a été mis à jour ; `pnpm` résoudra automatiquement ce package versionné chaque fois que nécessaire. Si d'autres packages dans le dépôt doivent dépendre de cette nouvelle version, assurez-vous que leurs `package.json` soient également mis à jour. -1. Mise à jour des chemins relatifs dans `tsconfig.json` ainsi que dans `tslint.json`. -2. Ajouter des règles de correspondance des chemins pour s'assurer que les tests s'exécutent avec la version prévue. +Par exemple, si nous créons `types/history/v2`, son `package.json` ressemblerait à ceci : + +```json +{ + "private": true, + "name": "@types/history", + "version": "2.4.9999" +} +``` -Par exemple, la bibliothèque [`history`](https://github.com/ReactTraining/history/) a introduit des changements entre les versions `2.x` et `3.x`. -Parce que beaucoup d'utilisateurs consomment encore l'ancienne version `2.x`, un mainteneur qui voulait mettre à jour les déclarations de type pour cette bibliothèque vers `3.x` a ajouté un dossier `v2` dans le référentiel history qui contient les déclarations de type pour l'ancienne version. -Au moment où j'écris ces lignes, le dossier [history v2 `tsconfig.json`](https://github.com/%44efinitelyTyped/DefinitelyTyped/blob/1253faabf5e0d2c5470db6ea87795d7f96fef7e2/types/history/v2/tsconfig.json) ressemble à peu près à ceci : +Un autre package peut sélectionner cette version en spécifiant : ```json { - "compilerOptions": { - "baseUrl": "../../", - "typeRoots": ["../../"], - "paths": { - "history": ["history/v2"] - } - }, - "files": [ - "index.d.ts", - "history-tests.ts" - ] + "private": true, + "name": "@types/browser-sync", + "version": "2.26.9999", + "dependencies": { + "@types/history": "^2" + } } ``` -S'il y a d'autres paquets dans Definitely Typed qui sont incompatibles avec la nouvelle version, vous devrez ajouter des correspondances de chemin vers l'ancienne version. -Vous devrez aussi le faire récursivement pour les paquets qui dépendent de l'ancienne version. +De plus, `/// ` ne fonctionnera pas avec le mappage de chemin, donc les dépendances doivent utiliser `import`. -Par exemple, `browser-sync` dépend de `micromatch@2`, donc [browser-sync `tsconfig.json`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/browser-sync/tsconfig.json) a un chemin vers `"micromatch" : ["micromatch/v2" ]`. -Transitivement, `browser-sync-webpack-plugin` (qui dépend de `browser-sync`) avait aussi besoin d'ajouter le même chemin (`"micromatch" : [ "micromatch/v2" ]`) dans son `tsconfig.json` jusqu'à ce que sa dépendance `browser-sync` soit mise à jour vers la dernière version. +#### Comment fonctionnent les changements de type majeurs si les packages de déclaration de type suivent de près la version du package de la bibliothèque ? -De plus, `/// ` ne fonctionnera pas avec la correspondance des chemins, donc les dépendances doivent utiliser `import`. +Les packages `@types` typent toujours les packages de la même version, donc `@types/foo@5.4.x` sont pour `foo@5.4.x`. +En conséquence, tous les changements, qu'ils soient majeurs ou non, sont publiés en tant que révisions de correctifs, sauf s'ils sont accompagnés d'une augmentation majeure/mineure pour changer la version du package ciblé (coïncidence ou non). -#### Comment puis-je écrire des définitions pour des paquets qui peuvent être utilisés globalement et en tant que module ? +En ce qui concerne les changements majeurs, les mainteneurs de DT prennent en compte la popularité du package, les avantages du changement proposé, l'effort nécessaire pour que les utilisateurs corrigent leur code, et si le changement pourrait raisonnablement être retardé jusqu'à ce qu'il puisse être synchronisé avec une augmentation majeure de la bibliothèque en amont. + +#### Comment puis-je écrire des définitions pour des packages qui peuvent être utilisés globalement et en tant que module ? Le manuel TypeScript contient d'excellentes [informations générales sur l'écriture de définitions](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html), ainsi que [cet exemple de fichier de définition](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/global-modifying-module-d-ts.html) qui montre comment créer une définition en utilisant la syntaxe de module de style ES6, tout en spécifiant également les objets mis à la disposition de la portée globale. Cette technique est démontrée en pratique dans la [définition de `big.js`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/big.js/index.d.ts), qui est une bibliothèque qui peut être chargée globalement via une balise script sur une page web, ou importée via require ou des importations de style ES6. @@ -630,21 +781,9 @@ Pour tester comment votre définition peut être utilisée à la fois lorsqu'ell Il suffit de tester uniquement les éléments accessibles globalement dans le fichier de test global et d'exercer pleinement la définition dans le fichier de test du module, ou vice versa. -#### Qu'en est-il des paquets délimités ? - -Les types pour un paquetage scopé `@foo/bar` devraient aller dans `types/foo__bar`. Notez le double trait de soulignement. - -Quand `dts-gen` est utilisé pour échafauder un paquet scopé, la propriété `paths` doit être adaptée manuellement dans le `tsconfig.json` généré pour référencer correctement le paquet scopé : +#### Qu'en est-il des packages scopés ? -```json -{ - "compilerOptions": { - "paths": { - "@foo/*": ["foo__*"] - } - } -} -``` +Les types pour un package avec un scope `@foo/bar` doivent être placés dans `types/foo__bar`. Notez le double underscore. ## Licence diff --git a/README.md b/README.md index e99fc246964fa1a..994458e1d12dbb2 100644 --- a/README.md +++ b/README.md @@ -135,11 +135,15 @@ then follow the instructions to [edit an existing package](#edit-an-existing-pac Once you've tested your package, you can share it on Definitely Typed. -First, [fork](https://guides.github.com/activities/forking/) this repository, [clone](#partial-clone) it, -install [node](https://nodejs.org/) and run `pnpm install`. Note that `pnpm install` will install the _entire_ -repository, including packages you may not be editing. If you'd like to install only a subset, -you can run `pnpm install -w --filter "{./types/foo}..."` to install `@types/foo` and all of -its dependencies. If you need to run tests for packages that _depend_ on `@types/foo`, you can run `pnpm install -w --filter "...{./types/foo}..."` to pull in all related packages for testing. +1. [Fork](https://guides.github.com/activities/forking/) this repository. +1. Clone it. + - The Definitely Typed repo is large; you may want to consider using a ["blobless clone"](https://github.blog/open-source/git/get-up-to-speed-with-partial-clone-and-shallow-clone/#user-content-blobless-clones) to save time and space by passing `--filter=blob:none` when running `git clone`. +1. Install [node](https://nodejs.org/). +1. Run `pnpm install`. + - `pnpm install` will install the _entire_ + repository, including packages you may not be editing. If you'd like to install only a subset, + you can run `pnpm install -w --filter "{./types/foo}..."` to install `@types/foo` and all of + its dependencies. If you need to run tests for packages that _depend_ on `@types/foo`, you can run `pnpm install -w --filter "...{./types/foo}..."` to pull in all related packages for testing. > [!NOTE] > If you are using Windows, you may find that `git clean` does not remove the `node_modules` directory or hangs when doing so. If you need to remove `node_modules`, you can run `pnpm clean-node-modules` to reset the repo. @@ -148,24 +152,6 @@ We use a bot to let a large number of pull requests to DefinitelyTyped be handle -#### Partial clone - -
-You can clone the entire repository as per usual, but it's large and includes a massive directory of type packages. - -You can clone the entire repository [as per usual](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository), but it's large and includes a massive directory of type packages. This will take some time to clone and may be unnecessarily unwieldy. - -For a more manageable clone that includes _only_ the type packages relevant to you, you can use git's [`sparse-checkout`](https://git-scm.com/docs/git-sparse-checkout) and [`--filter`](https://git-scm.com/docs/git-rev-list#Documentation/git-rev-list.txt---filterltfilter-specgt) features. This will reduce clone time and improve git performance. - -> :warning: This requires minimum [git version 2.27.0](https://git-scm.com/downloads), which is likely newer than the default on most machines. More complicated procedures are available in older versions, but not covered by this guide. - -1. `git clone --sparse --filter=blob:none ` - - `--sparse` initializes the sparse-checkout file so the working directory starts with only the files in the root of the repository. - - `--filter=blob:none` will including all commit history but exclude files, fetching them only as needed. -2. `git sparse-checkout add types/ types/ ...` - -
- #### Edit an existing package - Make changes. Remember to [edit tests](#my-package-teststs). @@ -605,7 +591,7 @@ Then they are wrong and we've not noticed yet. You can help by submitting a pull Yes, using [dprint](https://dprint.dev). We recommend using a [dprint extension for your editor](https://dprint.dev/install/#editor-extensions). -Alternatively, you can enable a git hook which will format your code automatically. Run `pnpm run setup-hooks`. Then, when you commit, `dprint fmt` command will be executed on changed files. If you take advantage of [partial clone](#partial-clone), make sure to call `git sparse-checkout add .husky` to check out the git hooks before running the `setup-hooks` script. +Alternatively, you can enable a git hook which will format your code automatically. Run `pnpm run setup-hooks`. Then, when you commit, `dprint fmt` command will be executed on changed files. Pull requests do not require correct formatting to be merged. Any unformatted code will be automatically reformatted after being merged. diff --git a/attw.json b/attw.json index d3fbfd018d9bbc4..62e365501175217 100644 --- a/attw.json +++ b/attw.json @@ -6,233 +6,49 @@ "cjs-resolves-to-esm" ], "failingPackages": [ - "acc-wizard", - "activex-access", - "activex-adodb", - "activex-adox", - "activex-dao", - "activex-diskquota", - "activex-excel", - "activex-faxcomexlib", - "activex-infopath", - "activex-interop", - "activex-iwshruntimelibrary", - "activex-libreoffice", - "activex-msforms", - "activex-mshtml", - "activex-msxml2", - "activex-office", - "activex-outlook", - "activex-powerpoint", - "activex-scripting", - "activex-shdocvw", - "activex-shell", - "activex-stdole", - "activex-vbide", - "activex-wia", - "activex-word", - "add2home", "af-utils__react-table", "af-utils__react-virtual-headless", "af-utils__react-virtual-list", "ahoy.js", - "akamai-edgeworkers", - "akumina-core", - "akumina-core/v4", "alcides", - "alipayjssdk", - "amap-js-api-arrival-range", - "amap-js-api-autocomplete", - "amap-js-api-city-search", - "amap-js-api-control-bar", - "amap-js-api-district-search", - "amap-js-api-driving", - "amap-js-api-geocoder", - "amap-js-api-geolocation", - "amap-js-api-heatmap", - "amap-js-api-indoor-map", - "amap-js-api-line-search", - "amap-js-api-map-type", - "amap-js-api-map3d", - "amap-js-api-overview", - "amap-js-api-place-search", - "amap-js-api-riding", - "amap-js-api-scale", - "amap-js-api-station-search", - "amap-js-api-tool-bar", - "amap-js-api-transfer", - "amap-js-api", - "amap-js-sdk", - "amcharts", - "amplifier", - "amplify-deferred", - "amplify", "amqplib", - "angular-agility", - "angular-bootstrap-calendar", - "angular-dialog-service", "angular-gridster", - "angular-httpi", - "angular-idle", - "angular-meteor", - "angular-notifications", - "angular-notify", - "angular-odata-resources", - "angular-q-spread", - "angular-ui-notification", - "angular-ui-router", - "angular-ui-tree", - "angular.throttle", - "angularfire", - "angularlocalstorage", - "ansicolors", - "aos", "apca-w3", - "apigee-access", "app-module-path", - "app-root-dir", - "appframework", - "apple-mapkit-js-browser", - "apple-music-api", - "apple-signin-api", - "applepayjs", - "appletvjs", - "arangodb", - "arbiter", - "arcgis-rest-api", "architect", - "assertsharp", - "async-polling", - "async-retry", - "atmosphere.js", - "atom", - "atpl", - "atvlegacycontentkit", - "auth0.widget", - "aws-cloudfront-function", - "aws-sdk2-types", - "aws-synthetics-puppeteer", "axios-cancel", - "azdata", - "azure-mobile-services-client", - "azure-sb", "babel-plugin-syntax-jsx", - "babel-types", - "babylon-walk", - "backbone.localstorage", - "backgrid", "backstopjs", - "baidu-app", - "baidumap-web-sdk", - "bbcode-to-react", - "behavior3", - "better-curry", "beyonk__gdpr-cookie-consent-banner", "bezier-js", - "bgiframe", "bidirectional-map", "big.js", - "bigint", - "bignum", - "bitcoin-computer__lib", - "blazor__javascript-interop", - "blissfuljs", - "bluebird-global", - "bmapgl-browser", - "boolify-string", - "bootstrap-maxlength", - "bootstrap-switch", - "bootstrap-touchspin", - "bootstrap-treeview", - "bootstrap.paginator", - "bootstrap.timepicker", - "bootstrap.v3.datetimepicker", - "bootstrap.v3.datetimepicker/v3", - "box2d", "brainhubeu__react-carousel", "bramus__pagination-sequence", - "breeze", "browserify", "bundle-id", - "bunyan-blackhole", "bwip-js", "byte-size", "call-bind", - "calq", - "cannon", - "canvasjs", - "carbon__layout", - "carbon__motion", - "carbon__themes", - "carbon__type", "casperjs", "chai/v4", - "channel-io", "chartjs-plugin-colorschemes", - "chartjs-plugin-doughnutlabel-rebourne", - "chayns", "chess.js", - "chessboardjs", - "chocolatechipjs", - "chrome-apps", - "chromecast-caf-receiver", - "chromecast-caf-sender", - "chui", "cldr", - "clearbladejs-client", - "clearbladejs-node", - "clearbladejs-server", - "closure-compiler", - "cloudflare-apps", - "cloudflare-turnstile", "cloudfour__simple-svg-placeholder", - "cloudinary-uploadwidget-browser", - "cls-hooked", - "colab", "collectionsjs", - "color/v0", - "com.wikitude.phonegap.wikitudeplugin", "combine-reducers", - "commangular", - "compose-function", "conditional", - "configs-overload", - "connect-flash", - "consumer-data-standards", - "content-type", - "contextjs", - "cookiebot-sdk", - "cookieclicker", - "cordova-ionic", - "cordova-plugin-background-mode", - "cordova-plugin-canvascamera", - "cordova-plugin-email-composer", - "cordova-plugin-ibeacon", - "cordova-plugin-mapsforge", - "cordova-plugin-ms-adal", "cornerstone-core", - "countdown", "country-flag-icons", - "cradle", - "createjs-lib", "critters-webpack-plugin", - "crossfilter", - "crossroads", "crypto-ld", - "cryptojs", "css-declaration-sorter", - "css-font-loading-module", - "css-modules", "css-tree", - "css", "csso", "culori", - "custom-functions-runtime", - "cybozulabs-md5", - "cyclonedx", "d3-array", "d3-axis", - "d3-box", "d3-brush", "d3-chord", "d3-color", @@ -247,7 +63,6 @@ "d3-format", "d3-geo", "d3-hierarchy", - "d3-indirections", "d3-interpolate", "d3-path", "d3-polygon", @@ -260,115 +75,24 @@ "d3-time-format", "d3-time", "d3-timer", - "d3-tip", "d3-transition", "d3-zoom", - "d3.slider", "d3", - "dadata-api", - "data-driven", - "dateformat", - "daum-postcode", - "db-migrate-base", - "db-migrate-pg", - "decorum", - "deep-freeze", - "deezer-sdk", "default-gateway", - "deku", "delaunator", "delowar__react-circle-progressbar", - "deoxxa-content-type", - "deployjava", - "desmos", - "devexpress-aspnetcore-bootstrap", - "devexpress-web", - "devexpress-web/v161", - "devexpress-web/v162", - "devexpress-web/v171", - "devexpress-web/v172", - "devexpress-web/v181", - "devexpress-web/v182", - "devexpress-web/v191", - "devexpress-web/v192", - "devexpress-web/v201", - "df-visible", - "dhtmlxgantt", - "dhtmlxscheduler", - "dialogify-browser", - "digital-goods-browser", - "doccookies", - "dock-spawn", - "documentdb-server", - "dom-background-sync", - "dom-chromium-installation-events", - "dom-inputevent", - "dom-mediacapture-record", - "dom-mediacapture-transform", - "dom-navigation-preload", - "dom-navigation", - "dom-screen-wake-lock", - "dom-serial", - "dom-speech-recognition", "dom-to-image", - "dom-trust-token", - "dom-view-transitions", - "dom-webcodecs", "dotenv-flow", - "double-ended-queue", - "doubleclick-gpt", "dplayer", "draggabilly", "drawflow", - "dropbox-chooser", - "dropboxjs", - "dts-bundle", - "duo_web_sdk", "durandal", - "durandal/v1", - "dvtng-jss", - "dw-bxslider-4", "dygraphs", - "dymo-label-framework", - "dynatable", - "dynmap", - "easy-api-request", - "easy-jsend", "easy-speech", - "easy-xapi-utils", - "easy-xapi", "editorjs__header", - "egg.js", - "ej.web.all", - "ejs-locals", "email-prompt", - "ember__application", - "ember__array", - "ember__component", - "ember__controller", - "ember__debug", - "ember__destroyable", - "ember__destroyable/v3", - "ember__engine", - "ember__error", - "ember__error/v3", - "ember__helper", - "ember__modifier", - "ember__object", "ember__ordered-set", "ember__ordered-set/v3", - "ember__owner", - "ember__polyfills", - "ember__polyfills/v3", - "ember__routing", - "ember__runloop", - "ember__service", - "ember__string/v2", - "ember__template", - "ember__template/v3", - "ember__test", - "ember__utils", - "ember__utils/v3", "ember-changeset-validations", "ember-data__adapter", "ember-data__adapter/v3", @@ -384,50 +108,20 @@ "ember-feature-flags", "ember-feature-flags/v3", "ember-task-scheduler", - "ember-test-helpers", - "ember-test-helpers/v0", - "ember-testing-helpers", - "ember", - "ember/v1", - "ember/v2", - "ember/v3", - "emissary", - "emscripten", "encoding-down", - "engine-check", - "eq.js", "error-cause", "es-get-iterator", - "es6-weak-map", - "esbuild-plugin-import-map", "eslint__eslintrc", "eslint-utils", - "espruino", - "estree-jsx", - "estree", "evaporate", "express-async-wrap", "express-brute-memcached", - "express-serve-static-core", - "express-serve-static-core/v4", "express-socket.io-session", "express-status-monitor", - "express-wechat-access", "extensible-duck", - "extjs", - "eyevinn-iaf", - "facebook-instant-games", - "facebook-js-sdk", - "facebook-pixel", "falcor-http-datasource", "famous", - "fancade-editor", - "fancybox", - "farbtastic", - "fast-levenshtein", - "favico.js", "feather-route-matcher", - "featherlight", "feathersjs__authentication-client", "feathersjs__authentication-jwt", "feathersjs__authentication-local", @@ -441,984 +135,115 @@ "feathersjs__rest-client", "feathersjs__socketio-client", "fetch.io", - "ffi", - "ffmpeg__libav-core", - "ffmpeg", - "fhir", - "fibjs", - "figma", - "filemaker-webviewer", - "filesystem", - "filewriter", - "finch", - "firefox-webext-browser", - "firemonkey-browser", - "flashpoint-launcher", - "flight", - "flipsnap", - "flot", - "flowdoc", - "flowjs", - "fm-websync", "fontkit", - "fontoxml", - "forge-viewer", "formidable", "formol", - "foundation", "frctl__fractal", "frecency", - "frida-gum", "fs-extra", - "ftdomdelegate", "fuzzy-finder", - "gae.channel.api", - "gamequery", - "gandi-livedns", - "gapi.analytics", - "gapi.auth2", - "gapi.calendar", - "gapi.client.abusiveexperiencereport-v1", - "gapi.client.acceleratedmobilepageurl-v1", - "gapi.client.accessapproval-v1", - "gapi.client.accesscontextmanager-v1", - "gapi.client.accesscontextmanager-v1beta", - "gapi.client.acmedns-v1", - "gapi.client.adexchangebuyer2-v2beta1", - "gapi.client.adexperiencereport-v1", - "gapi.client.admin-datatransfer_v1", - "gapi.client.admin-directory_v1", - "gapi.client.admin-reports_v1", - "gapi.client.admob-v1", - "gapi.client.admob-v1beta", - "gapi.client.adsense-v2", - "gapi.client.adsensehost-v4.1", - "gapi.client.advisorynotifications-v1", - "gapi.client.alertcenter-v1beta1", - "gapi.client.analytics-v3", - "gapi.client.analyticsadmin-v1alpha", - "gapi.client.analyticsadmin-v1beta", - "gapi.client.analyticsdata-v1beta", - "gapi.client.analyticshub-v1", - "gapi.client.analyticshub-v1beta1", - "gapi.client.analyticsreporting-v4", - "gapi.client.androiddeviceprovisioning-v1", - "gapi.client.androidenterprise-v1", - "gapi.client.androidmanagement-v1", - "gapi.client.androidpublisher-v3", - "gapi.client.apigateway-v1", - "gapi.client.apigateway-v1beta", - "gapi.client.apigeeregistry-v1", - "gapi.client.apikeys-v2", - "gapi.client.appengine-v1", - "gapi.client.appengine-v1alpha", - "gapi.client.appengine-v1beta", - "gapi.client.area120tables-v1alpha1", - "gapi.client.artifactregistry-v1", - "gapi.client.artifactregistry-v1beta1", - "gapi.client.artifactregistry-v1beta2", - "gapi.client.assuredworkloads-v1", - "gapi.client.assuredworkloads-v1beta1", - "gapi.client.authorizedbuyersmarketplace-v1", - "gapi.client.baremetalsolution-v2", - "gapi.client.batch-v1", - "gapi.client.beyondcorp-v1", - "gapi.client.beyondcorp-v1alpha", - "gapi.client.bigquery-v2", - "gapi.client.bigqueryconnection-v1beta1", - "gapi.client.bigquerydatatransfer-v1", - "gapi.client.bigqueryreservation-v1", - "gapi.client.bigtableadmin-v2", - "gapi.client.billingbudgets-v1", - "gapi.client.billingbudgets-v1beta1", - "gapi.client.binaryauthorization-v1", - "gapi.client.binaryauthorization-v1beta1", - "gapi.client.blogger-v2", - "gapi.client.blogger-v3", - "gapi.client.books-v1", - "gapi.client.businessprofileperformance-v1", - "gapi.client.calendar-v3", - "gapi.client.certificatemanager-v1", - "gapi.client.chat-v1", - "gapi.client.chromemanagement-v1", - "gapi.client.chromepolicy-v1", - "gapi.client.chromeuxreport-v1", - "gapi.client.civicinfo-v2", - "gapi.client.classroom-v1", - "gapi.client.cloudasset-v1", - "gapi.client.cloudasset-v1beta1", - "gapi.client.cloudasset-v1p1beta1", - "gapi.client.cloudasset-v1p5beta1", - "gapi.client.cloudasset-v1p7beta1", - "gapi.client.cloudbilling-v1", - "gapi.client.cloudbilling-v1beta", - "gapi.client.cloudbuild-v1", - "gapi.client.cloudchannel-v1", - "gapi.client.clouddeploy-v1", - "gapi.client.clouderrorreporting-v1beta1", - "gapi.client.cloudfunctions-v1", - "gapi.client.cloudfunctions-v2", - "gapi.client.cloudfunctions-v2alpha", - "gapi.client.cloudfunctions-v2beta", - "gapi.client.cloudidentity-v1", - "gapi.client.cloudidentity-v1beta1", - "gapi.client.cloudiot-v1", - "gapi.client.cloudkms-v1", - "gapi.client.cloudprofiler-v2", - "gapi.client.cloudresourcemanager-v1", - "gapi.client.cloudresourcemanager-v1beta1", - "gapi.client.cloudresourcemanager-v2", - "gapi.client.cloudresourcemanager-v2beta1", - "gapi.client.cloudresourcemanager-v3", - "gapi.client.cloudscheduler-v1", - "gapi.client.cloudscheduler-v1beta1", - "gapi.client.cloudsearch-v1", - "gapi.client.cloudshell-v1", - "gapi.client.cloudsupport-v2beta", - "gapi.client.cloudtasks-v2", - "gapi.client.cloudtasks-v2beta2", - "gapi.client.cloudtasks-v2beta3", - "gapi.client.cloudtrace-v1", - "gapi.client.cloudtrace-v2", - "gapi.client.cloudtrace-v2beta1", - "gapi.client.composer-v1", - "gapi.client.composer-v1beta1", - "gapi.client.compute-alpha", - "gapi.client.compute-beta", - "gapi.client.compute-v1", - "gapi.client.connectors-v1", - "gapi.client.connectors-v2", - "gapi.client.contactcenteraiplatform-v1alpha1", - "gapi.client.contactcenterinsights-v1", - "gapi.client.container-v1", - "gapi.client.container-v1beta1", - "gapi.client.containeranalysis-v1", - "gapi.client.containeranalysis-v1alpha1", - "gapi.client.containeranalysis-v1beta1", - "gapi.client.content-v2.1", - "gapi.client.contentwarehouse-v1", - "gapi.client.customsearch-v1", - "gapi.client.datacatalog-v1", - "gapi.client.datacatalog-v1beta1", - "gapi.client.dataflow-v1b3", - "gapi.client.dataform-v1beta1", - "gapi.client.datafusion-v1", - "gapi.client.datafusion-v1beta1", - "gapi.client.datalabeling-v1beta1", - "gapi.client.datalineage-v1", - "gapi.client.datamigration-v1", - "gapi.client.datamigration-v1beta1", - "gapi.client.datapipelines-v1", - "gapi.client.dataplex-v1", - "gapi.client.dataproc-v1", - "gapi.client.datastore-v1", - "gapi.client.datastore-v1beta1", - "gapi.client.datastore-v1beta3", - "gapi.client.datastream-v1", - "gapi.client.datastream-v1alpha1", - "gapi.client.deploymentmanager-alpha", - "gapi.client.deploymentmanager-v2", - "gapi.client.deploymentmanager-v2beta", - "gapi.client.dfareporting-v3.5", - "gapi.client.dfareporting-v4", - "gapi.client.dialogflow-v2", - "gapi.client.dialogflow-v2beta1", - "gapi.client.dialogflow-v3", - "gapi.client.dialogflow-v3beta1", - "gapi.client.digitalassetlinks-v1", - "gapi.client.discovery-v1", - "gapi.client.discoveryengine-v1alpha", - "gapi.client.discoveryengine-v1beta", - "gapi.client.displayvideo-v1", - "gapi.client.displayvideo-v2", - "gapi.client.dlp-v2", - "gapi.client.dns-v1", - "gapi.client.dns-v1beta2", - "gapi.client.docs-v1", - "gapi.client.documentai-v1", - "gapi.client.documentai-v1beta2", - "gapi.client.documentai-v1beta3", - "gapi.client.domains-v1", - "gapi.client.domains-v1alpha2", - "gapi.client.domains-v1beta1", - "gapi.client.domainsrdap-v1", - "gapi.client.doubleclickbidmanager-v1.1", - "gapi.client.doubleclickbidmanager-v2", - "gapi.client.doubleclicksearch-v2", - "gapi.client.drive-v2", - "gapi.client.drive-v3", - "gapi.client.driveactivity-v2", - "gapi.client.drivelabels-v2", - "gapi.client.drivelabels-v2beta", - "gapi.client.essentialcontacts-v1", - "gapi.client.eventarc-v1", - "gapi.client.eventarc-v1beta1", - "gapi.client.factchecktools-v1alpha1", - "gapi.client.fcm-v1", - "gapi.client.fcmdata-v1beta1", - "gapi.client.file-v1", - "gapi.client.file-v1beta1", - "gapi.client.firebase-v1beta1", - "gapi.client.firebaseappcheck-v1", - "gapi.client.firebaseappcheck-v1beta", - "gapi.client.firebaseappdistribution-v1", - "gapi.client.firebasedatabase-v1beta", - "gapi.client.firebasedynamiclinks-v1", - "gapi.client.firebasehosting-v1", - "gapi.client.firebasehosting-v1beta1", - "gapi.client.firebaseml-v1", - "gapi.client.firebaseml-v1beta2", - "gapi.client.firebaserules-v1", - "gapi.client.firebasestorage-v1beta", - "gapi.client.firestore-v1", - "gapi.client.firestore-v1beta1", - "gapi.client.firestore-v1beta2", - "gapi.client.fitness-v1", - "gapi.client.forms-v1", - "gapi.client.games_configuration-v1configuration", - "gapi.client.games_management-v1management", - "gapi.client.games-v1", - "gapi.client.gameservices-v1", - "gapi.client.gameservices-v1beta", - "gapi.client.genomics-v2alpha1", - "gapi.client.gkebackup-v1", - "gapi.client.gkehub-v1", - "gapi.client.gkehub-v1alpha", - "gapi.client.gkehub-v1alpha2", - "gapi.client.gkehub-v1beta", - "gapi.client.gkehub-v1beta1", - "gapi.client.gkehub-v2alpha", - "gapi.client.gmail-v1", - "gapi.client.gmailpostmastertools-v1", - "gapi.client.gmailpostmastertools-v1beta1", - "gapi.client.googleads-v10", - "gapi.client.googleads-v11", - "gapi.client.googleads-v12", - "gapi.client.googleads-v13", - "gapi.client.googleads-v4", - "gapi.client.googleads-v5", - "gapi.client.googleads-v6", - "gapi.client.googleads-v7", - "gapi.client.googleads-v8", - "gapi.client.googleads-v9", - "gapi.client.groupsmigration-v1", - "gapi.client.groupssettings-v1", - "gapi.client.healthcare-v1", - "gapi.client.healthcare-v1beta1", - "gapi.client.homegraph-v1", - "gapi.client.iam-v1", - "gapi.client.iam-v2", - "gapi.client.iam-v2beta", - "gapi.client.iamcredentials-v1", - "gapi.client.iap-v1", - "gapi.client.iap-v1beta1", - "gapi.client.identitytoolkit-v1", - "gapi.client.identitytoolkit-v2", - "gapi.client.identitytoolkit-v3", - "gapi.client.ids-v1", - "gapi.client.indexing-v3", - "gapi.client.integrations-v1alpha", - "gapi.client.jobs-v3", - "gapi.client.jobs-v3p1beta1", - "gapi.client.jobs-v4", - "gapi.client.keep-v1", - "gapi.client.kgsearch-v1", - "gapi.client.kmsinventory-v1", - "gapi.client.language-v1", - "gapi.client.language-v1beta2", - "gapi.client.libraryagent-v1", - "gapi.client.licensing-v1", - "gapi.client.lifesciences-v2beta", - "gapi.client.localservices-v1", - "gapi.client.logging-v2", - "gapi.client.managedidentities-v1", - "gapi.client.managedidentities-v1alpha1", - "gapi.client.managedidentities-v1beta1", - "gapi.client.manufacturers-v1", - "gapi.client.memcache-v1", - "gapi.client.memcache-v1beta2", - "gapi.client.metastore-v1", - "gapi.client.metastore-v1alpha", - "gapi.client.metastore-v1beta", - "gapi.client.migrationcenter-v1alpha1", - "gapi.client.ml-v1", - "gapi.client.monitoring-v1", - "gapi.client.monitoring-v3", - "gapi.client.mybusinessaccountmanagement-v1", - "gapi.client.mybusinessbusinesscalls-v1", - "gapi.client.mybusinessbusinessinformation-v1", - "gapi.client.mybusinesslodging-v1", - "gapi.client.mybusinessnotifications-v1", - "gapi.client.mybusinessplaceactions-v1", - "gapi.client.mybusinessqanda-v1", - "gapi.client.mybusinessverifications-v1", - "gapi.client.networkconnectivity-v1", - "gapi.client.networkconnectivity-v1alpha1", - "gapi.client.networkmanagement-v1", - "gapi.client.networkmanagement-v1beta1", - "gapi.client.networksecurity-v1", - "gapi.client.networksecurity-v1beta1", - "gapi.client.networkservices-v1", - "gapi.client.networkservices-v1beta1", - "gapi.client.notebooks-v1", - "gapi.client.notebooks-v2", - "gapi.client.oauth2-v2", - "gapi.client.ondemandscanning-v1", - "gapi.client.ondemandscanning-v1beta1", - "gapi.client.orgpolicy-v2", - "gapi.client.osconfig-v1", - "gapi.client.osconfig-v1alpha", - "gapi.client.osconfig-v1beta", - "gapi.client.oslogin-v1", - "gapi.client.oslogin-v1alpha", - "gapi.client.oslogin-v1beta", - "gapi.client.pagespeedonline-v5", - "gapi.client.paymentsresellersubscription-v1", - "gapi.client.people-v1", - "gapi.client.playcustomapp-v1", - "gapi.client.playdeveloperreporting-v1alpha1", - "gapi.client.playdeveloperreporting-v1beta1", - "gapi.client.playintegrity-v1", - "gapi.client.policyanalyzer-v1", - "gapi.client.policyanalyzer-v1beta1", - "gapi.client.policysimulator-v1", - "gapi.client.policysimulator-v1alpha", - "gapi.client.policysimulator-v1beta", - "gapi.client.policytroubleshooter-v1", - "gapi.client.policytroubleshooter-v1beta", - "gapi.client.poly-v1", - "gapi.client.privateca-v1", - "gapi.client.privateca-v1beta1", - "gapi.client.prod_tt_sasportal-v1alpha1", - "gapi.client.publicca-v1alpha1", - "gapi.client.publicca-v1beta1", - "gapi.client.pubsub-v1", - "gapi.client.pubsub-v1beta1a", - "gapi.client.pubsub-v1beta2", - "gapi.client.pubsublite-v1", - "gapi.client.readerrevenuesubscriptionlinking-v1", - "gapi.client.realtimebidding-v1", - "gapi.client.realtimebidding-v1alpha", - "gapi.client.recaptchaenterprise-v1", - "gapi.client.recommendationengine-v1beta1", - "gapi.client.recommender-v1", - "gapi.client.recommender-v1beta1", - "gapi.client.redis-v1", - "gapi.client.redis-v1beta1", - "gapi.client.reseller-v1", - "gapi.client.resourcesettings-v1", - "gapi.client.retail-v2", - "gapi.client.retail-v2alpha", - "gapi.client.retail-v2beta", - "gapi.client.run-v1", - "gapi.client.run-v2", - "gapi.client.runtimeconfig-v1", - "gapi.client.runtimeconfig-v1beta1", - "gapi.client.safebrowsing-v4", - "gapi.client.sasportal-v1alpha1", - "gapi.client.script-v1", - "gapi.client.searchads360-v0", - "gapi.client.searchconsole-v1", - "gapi.client.secretmanager-v1", - "gapi.client.secretmanager-v1beta1", - "gapi.client.securitycenter-v1", - "gapi.client.securitycenter-v1beta1", - "gapi.client.securitycenter-v1beta2", - "gapi.client.serviceconsumermanagement-v1", - "gapi.client.serviceconsumermanagement-v1beta1", - "gapi.client.servicecontrol-v1", - "gapi.client.servicecontrol-v2", - "gapi.client.servicedirectory-v1", - "gapi.client.servicedirectory-v1beta1", - "gapi.client.servicemanagement-v1", - "gapi.client.servicenetworking-v1", - "gapi.client.servicenetworking-v1beta", - "gapi.client.serviceusage-v1", - "gapi.client.serviceusage-v1beta1", - "gapi.client.sheets-v4", - "gapi.client.site_verification-v1", - "gapi.client.slides-v1", - "gapi.client.smartdevicemanagement-v1", - "gapi.client.sourcerepo-v1", - "gapi.client.spanner-v1", - "gapi.client.speech-v1", - "gapi.client.speech-v1p1beta1", - "gapi.client.sqladmin-v1", - "gapi.client.sqladmin-v1beta4", - "gapi.client.storage-v1", - "gapi.client.storagetransfer-v1", - "gapi.client.streetviewpublish-v1", - "gapi.client.sts-v1", - "gapi.client.sts-v1beta", - "gapi.client.tagmanager-v1", - "gapi.client.tagmanager-v2", - "gapi.client.tasks-v1", - "gapi.client.testing-v1", - "gapi.client.texttospeech-v1", - "gapi.client.texttospeech-v1beta1", - "gapi.client.toolresults-v1beta3", - "gapi.client.tpu-v1", - "gapi.client.tpu-v1alpha1", - "gapi.client.tpu-v2", - "gapi.client.tpu-v2alpha1", - "gapi.client.trafficdirector-v2", - "gapi.client.transcoder-v1", - "gapi.client.translate-v2", - "gapi.client.translate-v3", - "gapi.client.translate-v3beta1", - "gapi.client.travelimpactmodel-v1", - "gapi.client.vault-v1", - "gapi.client.verifiedaccess-v1", - "gapi.client.verifiedaccess-v2", - "gapi.client.versionhistory-v1", - "gapi.client.videointelligence-v1", - "gapi.client.videointelligence-v1beta2", - "gapi.client.videointelligence-v1p1beta1", - "gapi.client.videointelligence-v1p2beta1", - "gapi.client.videointelligence-v1p3beta1", - "gapi.client.vision-v1", - "gapi.client.vision-v1p1beta1", - "gapi.client.vision-v1p2beta1", - "gapi.client.vmmigration-v1", - "gapi.client.vmmigration-v1alpha1", - "gapi.client.vpcaccess-v1", - "gapi.client.vpcaccess-v1beta1", - "gapi.client.webfonts-v1", - "gapi.client.webrisk-v1", - "gapi.client.websecurityscanner-v1", - "gapi.client.websecurityscanner-v1alpha", - "gapi.client.websecurityscanner-v1beta", - "gapi.client.workflowexecutions-v1", - "gapi.client.workflowexecutions-v1beta", - "gapi.client.workflows-v1", - "gapi.client.workflows-v1beta", - "gapi.client.workloadmanager-v1", - "gapi.client.workstations-v1beta", - "gapi.client.youtube_analytics-v2", - "gapi.client.youtube-v3", - "gapi.client.youtubereporting-v1", - "gapi.client", - "gapi.drive", - "gapi.pagespeedonline", - "gapi.people", - "gapi.plus", - "gapi.translate", - "gapi.urlshortener", - "gapi.youtube", - "gapi.youtubeanalytics", - "gaugejs", - "generic-functions", - "gensync", - "gently", "geodesy", - "geojson", - "geometry-dom", - "get-emoji", "get-folder-size", - "get-symbol-description", - "git", "github-label-sync", - "gldatepicker", "glidejs__glide", - "glidejs", - "go", - "golang-wasm-exec", - "google-ads-scripts", - "google-adwords-scripts", - "google-apps-script-oauth2", "google-cloud__datastore", - "google-drive-realtime-api", - "google-earth", - "google-libphonenumber", - "google-one-tap", - "google-publisher-tag", - "google.accounts", - "google.analytics", - "google.feeds", - "google.fonts", - "google.geolocation", - "google.maps", - "google.picker", - "google.script.client-side", - "google.visualization", - "googlefc", - "googlemaps.infobubble", - "googlepay", - "googletag", - "gorilla-engine", - "graphql-resolve-batch", - "greasemonkey", - "greasemonkey/v3", - "grecaptcha", - "grecaptcha/v0", "gregorian-calendar", - "growing-io", - "gsi", - "gtag.js", "guacamole-common-js", - "guid", - "gulp-changed", - "gulp-cheerio", - "gulp-coffeeify", - "gulp-dtsm", - "gulp-espower", "gulp-imagemin", - "gulp-load-plugins", - "gulp-mocha", - "gulp-ng-annotate", - "gulp-remember", - "gulp-sourcemaps", - "gulp-task-listing", "gun", - "har-format", - "hard-source-webpack-plugin", "has-ansi", "has-package-exports", - "hasher", - "hashset", - "hashtable", - "hast", - "hast/v2", - "hasura", - "haxball-headless-browser", - "headroom", "hellosign-embedded", "hellosign-sdk", - "heredatalens", - "heremaps", - "heroku-logger", - "hl7", - "hmscore__react-native-hms-push", - "hookrouter", - "html-escaper", "html-minifier-terser", - "html-to-draftjs", "html-to-text", - "html5plus", - "htmlbars-inline-precompile", - "htmltojsx", - "hubspot-pace", - "hummer-env", - "hyperscript", - "hypertext-application-language", - "i18next-fs-backend", "i18next-sprintf-postprocessor", - "iab-vpaid", "ibm_db", - "ibm-mobilefirst", "identicon.js", "image-blob-reduce", - "imagemagick", - "imagemapster", "imagemin-svgo", "imagemin-webp", - "imgur-rest-api", - "inboxsdk", - "ineum", - "inherits", - "iniparser", "input-moment", "inputmask", - "intercom-web", - "intercomjs", "intl-unofficial-duration-unit-format", - "invity-api", - "ion-rangeslider/v1", "ioredis-mock", - "iost-contract", - "ipaiva", "iput", - "isomorphic-fetch", - "istanbul-middleware", "itemsjs", "itowns", - "ix.js", "jackrabbit", - "jake", - "jasmine-jquery", "jasmine", - "jasmine/v1", - "java-applet", - "javascript-astar", - "javascript-bignum", "javascript-time-ago", "jcof", - "jdataview", - "jee-jsf", "jest", - "jfp", - "jitsi-meet", - "jqgrid", - "jquery-alertable", - "jquery-backstretch", - "jquery-cropbox", "jquery-deferred", - "jquery-deparam", - "jquery-fullscreen", - "jquery-galleria", - "jquery-handsontable", - "jquery-jcrop", - "jquery-monthpicker", - "jquery-timeentry", - "jquery-toastmessage-plugin", - "jquery-truncate-html", - "jquery-urlparam", - "jquery.address", - "jquery.are-you-sure", - "jquery.autosize", - "jquery.base64", - "jquery.bbq", - "jquery.blockui", - "jquery.bootstrap.wizard", - "jquery.cleditor", - "jquery.clientsidelogging", - "jquery.color", - "jquery.colorbox", - "jquery.colorpicker", - "jquery.contextmenu", - "jquery.customselect", - "jquery.cycle", - "jquery.dropotron", - "jquery.dynatree", - "jquery.elang", - "jquery.fancytree", - "jquery.fileupload", - "jquery.filtertable", - "jquery.finger", - "jquery.flagstrap", - "jquery.form", - "jquery.fullscreen", - "jquery.gridster", - "jquery.highlight-bartaz", - "jquery.jnotify", - "jquery.joyride", - "jquery.jsignature", - "jquery.leanmodal", - "jquery.livestampjs", - "jquery.menuaim", - "jquery.mmenu", - "jquery.notify", - "jquery.notifybar", - "jquery.noty", - "jquery.pjax", - "jquery.placeholder", - "jquery.pnotify", - "jquery.postmessage", - "jquery.prettyphoto", - "jquery.qrcode", - "jquery.rowgrid", - "jquery.simplemodal", - "jquery.simplepagination", - "jquery.simulate", - "jquery.sortelements", - "jquery.stickem", - "jquery.superlink", - "jquery.tagsmanager", - "jquery.tile", - "jquery.timeago", - "jquery.timepicker", - "jquery.timer", - "jquery.tinycarousel", - "jquery.tinyscrollbar", - "jquery.tipsy", - "jquery.tools", - "jquery.total-storage", - "jquery.ui.datetimepicker", - "jquery.ui.layout", - "jquery.uniform", - "jquery.validation", - "jquery.watermark", - "jquery.window", - "jquery/v1", - "jquery/v2", - "jquerymobile", - "js-clipper", - "js-schema", - "js-url", - "js.spec", - "jsbn", - "jsdeferred", - "jsfl", "jsftp", "jslib-html5-camera-photo", - "json-editor", - "json-patch", - "json-pointer", "json-schema-faker", - "json-schema", "jsoneditor-for-react", "jsoneditor", - "jsoneditoronline", "jsonpath-plus", - "jsonstream", - "jsqrcode", - "jstorage", - "justifiedgallery", - "jwplayer", - "jxon", - "k6", - "kakao-js-sdk", - "kakao-pixel", - "kakaomaps", - "kamailio-kemi", - "kap-plugin", "katex", "keep-network__tbtc.js", - "kendo-ui", - "kik-browser", - "kineticjs", - "knockback", - "knockout-amd-helpers", - "knockout-postbox", - "knockout-secure-binding", - "knockout.deferred.updates", - "knockout.editables", - "knockout.es5", - "knockout.kogrid", - "knockout.mapper", - "knockout.mapping", - "knockout.projections", - "knockout.rx", - "knockout.validation", - "knockout.viewmodel", - "knockstrap", - "knuddels-userapp-backend-api", - "knuddels-userapps-api", - "knuddels-webapp-frontend-api", - "koa-proxy", "koa", - "kolite", - "konami.js", - "kos-core", "kss", - "kythe", - "leadfoot", - "leaflet-areaselect", - "leaflet-curve", - "leaflet-editable/v0", - "leaflet-gpx", - "leaflet-label", - "leaflet-offline", - "leaflet.awesome-markers/v0", - "leapmotionts", - "lestate", - "level-sublevel", "leveldown", - "line-reader", "lint-staged", - "lls", - "loadable__webpack-plugin", - "localizejs-library", "locutus", - "logg", - "login-with-amazon-sdk-browser", - "lowlight", - "ltx", "luxon", - "macaca-circular-json", - "magic-number", - "magicmirror-module", - "maildev", "mapbox__mapbox-sdk", - "mapbox", "mapboxgl-spiderifier", - "mapsjs", - "markdown-it-lazy-headers", - "markitup", "marv", - "maskedinput", "material-ui-pagination", "material-ui-phone-number", - "material-ui", - "mathjax", - "maxmsp", - "mcustomscrollbar", - "mdast", - "mdx", "megajs", - "mem-cache", "memdown", - "mercadopago-sdk-js", "mergerino", - "messenger", "metascraper", - "meteor-accounts-phone", - "meteor-collection-hooks", - "meteor-dburles-collection-helpers", - "meteor-jboulhous-dev", - "meteor-percolate-migrations", - "meteor-persistent-session", - "meteor-prime8consulting-oauth2", - "meteor-publish-composite", - "meteor-roles", - "meteor-sjobs", - "mfiles", "micromodal", - "microservice-utilities", - "microsoft-ajax", - "microsoft-graph", - "microsoft-live-connect", - "microsoft-sdk-soap", - "microsoftteams", "mimetext", - "mina", - "minapp-env", "minify", - "miniprogram-wxs", - "miniprogram", - "mithril-global", "mixpanel-browser", - "mixpanel", - "mixto", "ml-classify-text", - "mobile-messaging-cordova", "modular-scale", "module-deps", - "mojang-gametest", - "mojang-minecraft-server-admin", - "mojang-minecraft-ui", - "mojang-minecraft", - "mojang-net", "mongoose-deep-populate", - "mongoose-promise", "motor-hat", - "mpv-script", - "msgpack", - "mu2", "mudder", - "musickit-js", "musicmatch", "mysql-import", - "naver-whale", - "navermaps", - "nedb-logger", - "neo4j", - "netease-captcha", - "netlify-auth-providers", - "new-relic-browser", "next-nprogress", - "ng-command", - "ng-facebook", - "ng-flow", - "ng-grid", - "ng-i18next", - "ngbootbox", - "ngprogress-lite", "ngreact", - "ngtoaster", - "ngwysiwyg", - "nlcst", - "nlcst/v1", - "noble-mac", - "node_redis", "node-fetch-cache", - "node-fibers", - "node-mysql-wrapper", "node-osc", - "node-sass-middleware", - "node-uuid", - "nodegit", - "nodeunit", - "nomnom", - "noteflight-client", "notie", - "notify", - "notifyjs-browser", - "nova-editor-node", - "nova-editor", "npm", - "nunjucks-date", - "nw.gui", - "nw.js", - "oauth.js", "object.groupby", - "obs-studio", - "office-js-preview", - "office-js", - "office-runtime", - "offscreencanvas", - "oidc-token-manager", "onfleet__node-onfleet", - "onflow__flow-js-testing", "onscan.js", "opencc-js", - "openfin", - "openfin/v50", - "openjscad", - "openlayers/v2", - "openrct2", - "openssi-websdk", "opentok", - "openui5", - "optimist", "osmtogeojson", - "paddle-js-browser", "page-flip", "pako", - "paralleljs", - "parcel-env", "parse-listing", "parse/v1", "passport-discord", - "passport-github2", - "passport-strategy", - "passport-vkontakte", - "passport", - "pathfinding", - "paypal-cordova-plugin", - "payu-emea-sdk", - "pebblekitjs", - "pendo-io-browser", - "pexrtc", "phoenix", - "phonegap-facebook-plugin", - "phonegap-plugin-barcodescanner", - "phonegap", - "photoshop", - "pi-spi", - "pinterest-sdk", - "places", - "plaid-link", - "playerframework", "playmusic", - "plupload", - "plv8-internal", "polylabel", - "polymer", - "poool-access", - "popcorn", "postcss-functions", "postcss-js", "posterus", "pouch-redux-middleware", - "pouchdb-http", - "preact-i18n", - "precise", - "preloadjs", "pretty-proptypes", "prismic-dom", - "progressjs", - "promise-pg", - "promise-pool", - "promise-sftp", "proper-url-join", - "proposal-relative-indexing-method", - "pump", - "purl", - "q-retry", - "qlik-engineapi", - "qlik-visualizationextensions", "query-string-params", "quicksettings", - "qunit/v1", "rabbit.js", "radium", - "radius", - "rangy", "raphael", - "rappid", "rasa-webchat", - "raty", "raygun4js", "rc-switch", "rc-tooltip", @@ -1426,275 +251,113 @@ "react-animals", "react-animate-on-scroll", "react-animated-modal", - "react-better-password", - "react-cache", "react-coinhive", - "react-color", "react-compass", - "react-custom-scroll", "react-cytoscapejs", - "react-date-range/v0", - "react-document-meta", "react-dom", "react-dom/v18", "react-dynamic-number", "react-email-editor", "react-embed-gist", - "react-facebook-login-component", "react-facebook-login", "react-flags-select", - "react-google-places-suggest", "react-highcharts", "react-highlight", "react-holder", "react-howler", "react-html5-camera-photo", - "react-icofont", "react-icon-base", "react-image-gallery", "react-imgpro", - "react-infinite", - "react-input-mask", "react-input-mask/v1", "react-instantsearch", "react-js-table-with-csv-dl", "react-jsonschema-form", - "react-key-handler", - "react-leaflet-markercluster", - "react-linkify", "react-loadable-visibility", "react-mailchimp-subscribe", "react-native-bcrypt", - "react-native-bluetooth-serial", "react-native-honeywell-scanner", - "react-native-huawei-protected-apps", - "react-native-material-ui", "react-native-modalbox", - "react-native-modern-datepicker", "react-native-multi-slider", - "react-native-orientation", "react-native-qrcode", "react-native-scrollable-tab-view", "react-native-signature-capture", "react-native-svg-animated-linear-gradient", - "react-native-toast-native", - "react-onsenui", "react-paginate", "react-paginate/v5", "react-payment-inputs", - "react-pie-menu", "react-plyr", - "react-pointable", "react-recaptcha-v3", "react-recompose", "react-responsive-spritesheet", - "react-router-navigation-core", - "react-router-navigation", - "react-router-redux", "react-rte", "react-sidebar", - "react-sortable-tree-theme-file-explorer", - "react-sortable-tree", "react-svg-radar-chart", - "react-swf", "react-switch-case", "react-syntax-highlighter", "react-tag-autocomplete", "react-tag-autocomplete/v5", "react-tag-input", - "react-tap-event-plugin", "react-text-mask", - "react-touch", "react-transition-group", "react-type-animation", "react-typical", "react-typing-effect", "react-widgets-moment", "react-youtube-embed", - "readmore-js", - "recharts-scale", "recompose", - "recurly__recurly-js", "redux-cablecar", - "redux-form/v7", "redux-localstorage-debounce", - "redux-localstorage", "redux-persist-transform-encrypt", "redux-storage", - "remotedev-serialize", "require-hacker", - "resize-observer-browser", "resolve", "rest", "restful.js", "resx", "rewire", - "rickshaw", - "riderize__passport-strava-oauth2", - "riot-api-nodejs", - "riot-games-api", - "riotjs", - "rn-fetch-blob", "rocksdb", - "rollup-plugin-svelte-svg", "rollup-plugin-url", - "rosie", - "route-parser", - "routie", - "royalslider", - "rx-jquery", - "rx-node", - "s3-uploader", - "safari-extension-content", - "safari-extension", - "sammy", - "sarif", - "sat", - "satnav", - "scaleway-functions", "schluessel", - "scorm-browser", - "screeps-arena", - "scriptable-ios", - "scriptjs", "scrollbooster", - "scroller", - "scrollreveal", - "scrolltofixed", - "segment-analytics", - "sencha_touch", - "sequencify", "serverless", - "servicenow-london", - "servicenow", "sfdx-faye", "shakacode__recompose", - "sharepoint", - "shexj", "siema", - "sigmajs", - "signalfx-collect", - "signalr/v1", "simpl-schema", - "simple-cw-node", - "simple-url-cache", - "simple-xml", "simpleddp", "sinon", - "sipml", "siren-parser", - "six-runtime", - "sketchapp", - "ski", "smallwei__avue", - "smart-fox-server", - "snapchat-lens-studio", - "snowpack-env", - "socket.io.users", "solid-auth-client", - "soundjs", - "space-pen", - "spectrum", - "sphere-engine-browser", - "sphere-engine-browser/v1", "splitpanes/v1", - "spotify-web-playback-sdk", - "spreedly-iframe-browser", "srtparsejs", "stampit", - "stamplay-js-sdk", - "stream-to-array/v0", - "stripe-v2", - "stripe-v3", - "stripejs", - "stronghold-pay-js", "struct", - "styled-components-react-native", "styled-components", "styled-components/v3", "stylis", - "succinct", - "suitescript", - "svg-maps__common", - "svgjs.draggable", - "svgjs.resize", - "swagger-schema-official", "swagger2openapi", - "swig", - "swipe", - "swipeview", - "switchery", - "swiz", - "sylvester", "systemjs", - "tableau-js-api", - "tableau", - "tampermonkey", "tasker-js-runner", - "tea-merge", - "teechart", - "telegram-web-app", "tern", "throttle-debounce", - "thunderbird-webext-browser", "timed-cache", - "timelinejs", - "timezone-js", - "tinajs__tina-redux", - "titanium", - "tizen-accessory", - "to-title-case-gouch", - "tooltipster", - "topojson-specification", - "topojson", - "torrent-stream", - "tpdirect", - "trim", "tryghost__content-api", - "twine-sugarcube", - "twitch-browser", - "twitch-ext", - "twitter-for-web", "typography", "uikit", - "umami-browser", - "umbraco", - "underscore-ko", - "underscore.string", "ungap__structured-clone", - "uni-app", - "unist", - "unist/v2", - "unity-webapi", "unpaginated", "url-format-lax", - "url-join/v0", "url-parse-lax", "url-state", - "urlparser", - "urlrouter", - "usage", "use-combined-reducers", "use-global-hook", - "use-persisted-state", - "use-sync-external-store", - "user-event", - "uws", - "valdr-message", - "valerie-browser", "vanillajs-datepicker", - "venn", "verovio", "video.js", "videojs-contrib-quality-levels", - "viewporter", "vision/v4", - "vk-openapi", - "vortex-web-client", - "vscode-notebook-renderer", - "vscode-webview", - "vscode", - "vue-datetime", "vue-json-compare", "vue-ls", "vue-scroll-up", @@ -1702,95 +365,16 @@ "vue-splitpane", "vue-tel-input", "vue2-editor", - "w3c-css-typed-object-model-level-1", - "w3c-generic-sensor", - "w3c-image-capture", - "w3c-web-hid", - "w3c-web-nfc", - "w3c-web-serial", - "w3c-web-usb", - "waitme", - "wallabyjs", - "wampy", - "weapp-api", - "web-app-manifest", - "web-ie11", - "web-locks-api", - "webappsec-credential-management", - "webassembly-web-api", - "webcl", - "webcrypto", - "webgl-ext", - "webgl2-compute", - "webgl2", "webidl2", - "webos-service", - "webpack-env", "webscopeio__react-textarea-autocomplete", - "webscreens-window-placement", - "websql", - "webvr-api", - "webxr", - "wechat-miniprogram-xmly", - "wechat-miniprogram", - "wegame-api", - "weixin-app", - "wepy-redux", "when", - "wicg-entries-api", - "wicg-file-system-access", - "wicg-js-self-profiling", - "wicg-mediasession", - "wicg-web-app-launch", - "wiiu", "winbox", - "windows-script-host", - "winjs/v1", - "winjs/v2", - "winrt-uwp", - "winrt", - "winston-dynamodb", - "wistia-player-browser", "wnumb", - "wonder.js", - "woosmap.map", - "wordpress__admin", - "wordpress__customize-browser", - "workerb-api", - "workgrid-core", - "workgrid-toolbar", - "wrench", - "write-file-webpack-plugin", - "wx-js-sdk-browser", - "wx-js-sdk-dt", - "xast", - "xast/v1", - "xelib", - "xk6-sql-browser", - "xmltojson", - "xmpp__jid", - "xrm", - "xrm/v6", - "xrm/v7", - "xrm/v8", - "xsockets", - "yandex-maps", - "yandex-metrika-tag", - "yandex-money-sdk", "yargs-parser", "yargs-parser/v20", "yargs/v16", "yargs/v16", - "ydn-db", - "yelp-fusion-plus", "youtube-player", - "zchat-browser", - "zedit__upf", - "zengin-code", - "zip.js", - "zmq", - "zumly", - "zwjsbridge", - "zwlog-browser" + "zumly" ] } diff --git a/dangerfile.ts b/dangerfile.ts index 5ce227986e2a94f..9c4dae8a09717dd 100644 --- a/dangerfile.ts +++ b/dangerfile.ts @@ -2,7 +2,7 @@ import fs = require("fs"); import os = require("os"); import path = require("path"); import cp = require("child_process"); -import { suggestionsDir } from "@definitelytyped/utils"; +import { mangleScopedPackage, suggestionsDir } from "@definitelytyped/utils"; import { danger, fail, markdown } from "danger"; const lines: string[] = []; const missingProperty = /module exports a property named '(.+?)', which is missing/; @@ -38,7 +38,7 @@ if (fs.existsSync(suggestionsDir)) { if (Object.keys(missingProperties).length > 1) { const originalJS = fileName.replace(".d.ts", ".js"); const unpkgURL = `https://unpkg.com/browse/${packageName}@latest/${originalJS}`; - const dtsName = packageName.replace("@", "").replace("/", "__"); + const dtsName = `@types/${mangleScopedPackage(packageName)}`; const dtsURL = `https://github.com/DefinitelyTyped/DefinitelyTyped/blob/${danger.github.pr.head.sha}/types/${dtsName}/${fileName}`; diff --git a/notNeededPackages.json b/notNeededPackages.json index ea560371704db3f..5358afc0df0bf81 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -60,6 +60,10 @@ "libraryName": "agenda", "asOfVersion": "4.1.0" }, + "agent-base": { + "libraryName": "agent-base", + "asOfVersion": "5.0.0" + }, "aggregate-error": { "libraryName": "aggregate-error", "asOfVersion": "2.2.0" @@ -512,6 +516,14 @@ "libraryName": "burns", "asOfVersion": "2.1.0" }, + "cache-manager": { + "libraryName": "cache-manager", + "asOfVersion": "5.0.0" + }, + "cache-manager-redis-store": { + "libraryName": "cache-manager-redis-store", + "asOfVersion": "3.0.0" + }, "cacheable-request": { "libraryName": "cacheable-request", "asOfVersion": "8.3.1" @@ -604,6 +616,10 @@ "libraryName": "change-case", "asOfVersion": "2.3.1" }, + "chardet": { + "libraryName": "chardet", + "asOfVersion": "1.0.0" + }, "chartist": { "libraryName": "chartist", "asOfVersion": "1.0.0" @@ -1012,10 +1028,18 @@ "libraryName": "constant-case", "asOfVersion": "1.1.2" }, + "consul": { + "libraryName": "consul", + "asOfVersion": "2.0.0" + }, "contentstack": { "libraryName": "contentstack", "asOfVersion": "3.11.0" }, + "conventional-changelog-preset-loader": { + "libraryName": "conventional-changelog-preset-loader", + "asOfVersion": "5.0.0" + }, "conventional-recommended-bump": { "libraryName": "conventional-recommended-bump", "asOfVersion": "10.0.0" @@ -1453,6 +1477,10 @@ "libraryName": "domelementtype", "asOfVersion": "2.0.1" }, + "domhandler": { + "libraryName": "domhandler", + "asOfVersion": "3.1.0" + }, "dompurify": { "libraryName": "dompurify", "asOfVersion": "3.2.0" @@ -1497,6 +1525,10 @@ "libraryName": "easystarjs", "asOfVersion": "0.3.1" }, + "echarts": { + "libraryName": "echarts", + "asOfVersion": "5.0.0" + }, "ecmarkup": { "libraryName": "ecmarkup", "asOfVersion": "3.4.0" @@ -1549,6 +1581,10 @@ "libraryName": "electron-debug", "asOfVersion": "2.1.0" }, + "electron-devtools-installer": { + "libraryName": "electron-devtools-installer", + "asOfVersion": "4.0.0" + }, "electron-is-dev": { "libraryName": "electron-is-dev", "asOfVersion": "1.1.0" @@ -1617,6 +1653,10 @@ "libraryName": "empty-trash", "asOfVersion": "3.0.0" }, + "engine.io-client": { + "libraryName": "engine.io-client", + "asOfVersion": "6.0.0" + }, "enhanced-resolve": { "libraryName": "enhanced-resolve", "asOfVersion": "5.0.0" @@ -1657,6 +1697,14 @@ "libraryName": "es-module-lexer", "asOfVersion": "0.4.1" }, + "es-to-primitive": { + "libraryName": "es-to-primitive", + "asOfVersion": "1.3.0" + }, + "es-value-fixtures": { + "libraryName": "es-value-fixtures", + "asOfVersion": "1.5.0" + }, "es6-error": { "libraryName": "es6-error", "asOfVersion": "4.0.2" @@ -1689,6 +1737,10 @@ "libraryName": "ethereumjs-util", "asOfVersion": "6.1.0" }, + "euclidean-rhythms": { + "libraryName": "euclidean-rhythms", + "asOfVersion": "3.0.0" + }, "eventemitter2": { "libraryName": "eventemitter2", "asOfVersion": "4.1.0" @@ -1793,6 +1845,10 @@ "libraryName": "extended-listbox", "asOfVersion": "4.0.1" }, + "extract-colors": { + "libraryName": "extract-colors", + "asOfVersion": "3.0.0" + }, "extract-stack": { "libraryName": "extract-stack", "asOfVersion": "2.0.0" @@ -2117,6 +2173,10 @@ "libraryName": "get-stream", "asOfVersion": "5.0.0" }, + "get-symbol-description": { + "libraryName": "get-symbol-description", + "asOfVersion": "1.1.0" + }, "get-urls": { "libraryName": "get-urls", "asOfVersion": "9.1.0" @@ -2177,6 +2237,10 @@ "libraryName": "@google-cloud/text-to-speech", "asOfVersion": "2.0.0" }, + "google-maps": { + "libraryName": "google-maps", + "asOfVersion": "4.0.0" + }, "google-maps-react": { "libraryName": "google-maps-react", "asOfVersion": "2.0.5" @@ -2277,6 +2341,10 @@ "libraryName": "@hapi/boom", "asOfVersion": "9.0.0" }, + "hapi__catbox-memory": { + "libraryName": "@hapi/catbox-memory", + "asOfVersion": "6.0.2" + }, "hapi__code": { "libraryName": "@hapi/code", "asOfVersion": "8.0.0" @@ -2309,18 +2377,34 @@ "libraryName": "@hapi/topo", "asOfVersion": "5.0.0" }, + "hapi__vision": { + "libraryName": "@hapi/vision", + "asOfVersion": "7.0.2" + }, "hapi__wreck": { "libraryName": "@hapi/wreck", "asOfVersion": "17.0.0" }, + "hapi__yar": { + "libraryName": "@hapi/yar", + "asOfVersion": "11.0.2" + }, "hard-rejection": { "libraryName": "hard-rejection", "asOfVersion": "2.0.0" }, + "has-bigints": { + "libraryName": "has-bigints", + "asOfVersion": "1.1.0" + }, "has-emoji": { "libraryName": "has-emoji", "asOfVersion": "1.1.0" }, + "has-symbols": { + "libraryName": "has-symbols", + "asOfVersion": "1.1.0" + }, "has-yarn": { "libraryName": "has-yarn", "asOfVersion": "2.0.0" @@ -2337,6 +2421,10 @@ "libraryName": "hashids", "asOfVersion": "2.0.0" }, + "hcaptcha__react-hcaptcha": { + "libraryName": "@hcaptcha/react-hcaptcha", + "asOfVersion": "0.3.7" + }, "hedron": { "libraryName": "hedron", "asOfVersion": "1.0.1" @@ -2349,6 +2437,14 @@ "libraryName": "hex-rgb", "asOfVersion": "4.1.0" }, + "hexo": { + "libraryName": "hexo", + "asOfVersion": "7.0.0" + }, + "hexo-fs": { + "libraryName": "hexo-fs", + "asOfVersion": "4.0.0" + }, "hibp": { "libraryName": "hibp", "asOfVersion": "7.3.0" @@ -2433,6 +2529,10 @@ "libraryName": "humanize-url", "asOfVersion": "2.1.0" }, + "i18n-js": { + "libraryName": "i18n-js", + "asOfVersion": "4.0.1" + }, "i18next": { "libraryName": "i18next", "asOfVersion": "13.0.0" @@ -2445,6 +2545,10 @@ "libraryName": "i18next-express-middleware", "asOfVersion": "1.7.0" }, + "i18next-fs-backend": { + "libraryName": "i18next-fs-backend", + "asOfVersion": "1.2.0" + }, "i18next-xhr-backend": { "libraryName": "i18next-xhr-backend", "asOfVersion": "1.4.2" @@ -2525,6 +2629,10 @@ "libraryName": "internal-ip", "asOfVersion": "4.1.0" }, + "internal-slot": { + "libraryName": "internal-slot", + "asOfVersion": "1.1.0" + }, "intl-locales-supported": { "libraryName": "intl-locales-supported", "asOfVersion": "1.0.6" @@ -2601,18 +2709,38 @@ "libraryName": "is-archive", "asOfVersion": "2.0.0" }, + "is-arguments": { + "libraryName": "is-arguments", + "asOfVersion": "1.2.0" + }, "is-array-sorted": { "libraryName": "is-array-sorted", "asOfVersion": "2.0.0" }, + "is-async-function": { + "libraryName": "is-async-function", + "asOfVersion": "2.1.0" + }, + "is-bigint": { + "libraryName": "is-bigint", + "asOfVersion": "1.1.0" + }, "is-binary-path": { "libraryName": "is-binary-path", "asOfVersion": "2.1.0" }, + "is-boolean-object": { + "libraryName": "is-boolean-object", + "asOfVersion": "1.2.0" + }, "is-compressed": { "libraryName": "is-compressed", "asOfVersion": "2.0.0" }, + "is-date-object": { + "libraryName": "is-date-object", + "asOfVersion": "1.1.0" + }, "is-docker": { "libraryName": "is-docker", "asOfVersion": "2.0.0" @@ -2625,6 +2753,10 @@ "libraryName": "is-fullwidth-code-point", "asOfVersion": "3.0.0" }, + "is-generator-function": { + "libraryName": "is-generator-function", + "asOfVersion": "1.1.0" + }, "is-image": { "libraryName": "is-image", "asOfVersion": "3.0.0" @@ -2641,6 +2773,10 @@ "libraryName": "is-lower-case", "asOfVersion": "1.1.2" }, + "is-map": { + "libraryName": "is-map", + "asOfVersion": "2.0.3" + }, "is-mobile": { "libraryName": "is-mobile", "asOfVersion": "2.1.0" @@ -2649,6 +2785,10 @@ "libraryName": "is-my-json-valid", "asOfVersion": "2.18.0" }, + "is-negative-zero": { + "libraryName": "is-negative-zero", + "asOfVersion": "2.0.3" + }, "is-obj": { "libraryName": "is-obj", "asOfVersion": "2.0.0" @@ -2689,6 +2829,10 @@ "libraryName": "is-reachable", "asOfVersion": "3.1.0" }, + "is-regex": { + "libraryName": "is-regex", + "asOfVersion": "1.2.0" + }, "is-regexp": { "libraryName": "is-regexp", "asOfVersion": "2.1.0" @@ -2709,6 +2853,10 @@ "libraryName": "is-scoped", "asOfVersion": "2.0.0" }, + "is-set": { + "libraryName": "is-set", + "asOfVersion": "2.0.3" + }, "is-stream": { "libraryName": "is-stream", "asOfVersion": "2.0.0" @@ -2717,6 +2865,10 @@ "libraryName": "is-svg", "asOfVersion": "4.0.1" }, + "is-symbol": { + "libraryName": "is-symbol", + "asOfVersion": "1.1.0" + }, "is-text-path": { "libraryName": "is-text-path", "asOfVersion": "2.0.0" @@ -2729,6 +2881,10 @@ "libraryName": "is-url-superb", "asOfVersion": "3.0.0" }, + "is-weakref": { + "libraryName": "is-weakref", + "asOfVersion": "1.1.0" + }, "ismobilejs": { "libraryName": "ismobilejs", "asOfVersion": "1.0.0" @@ -2793,6 +2949,10 @@ "libraryName": "expect", "asOfVersion": "25.1.0" }, + "jest-preset-stylelint": { + "libraryName": "jest-preset-stylelint", + "asOfVersion": "5.0.0" + }, "jest-validate": { "libraryName": "jest-validate", "asOfVersion": "25.1.0" @@ -2869,6 +3029,10 @@ "libraryName": "json-schema-traverse", "asOfVersion": "1.0.0" }, + "json-stable-stringify": { + "libraryName": "json-stable-stringify", + "asOfVersion": "1.2.0" + }, "json-stream-stringify": { "libraryName": "json-stream-stringify", "asOfVersion": "2.0.3" @@ -3061,6 +3225,10 @@ "libraryName": "known", "asOfVersion": "3.0.0" }, + "koa-graphql": { + "libraryName": "koa-graphql", + "asOfVersion": "0.12.0" + }, "koa-jwt": { "libraryName": "koa-jwt", "asOfVersion": "3.3.0" @@ -3121,6 +3289,10 @@ "libraryName": "left-pad", "asOfVersion": "1.2.0" }, + "level": { + "libraryName": "level", + "asOfVersion": "8.0.0" + }, "leven": { "libraryName": "leven", "asOfVersion": "3.0.0" @@ -3249,6 +3421,10 @@ "libraryName": "lorem-ipsum", "asOfVersion": "2.0.0" }, + "lossless-json": { + "libraryName": "lossless-json", + "asOfVersion": "2.0.0" + }, "loud-rejection": { "libraryName": "loud-rejection", "asOfVersion": "2.0.0" @@ -3501,6 +3677,10 @@ "libraryName": "meow", "asOfVersion": "6.0.0" }, + "merge-refs": { + "libraryName": "merge-refs", + "asOfVersion": "1.1.0" + }, "mermaid": { "libraryName": "mermaid", "asOfVersion": "9.2.0" @@ -3549,6 +3729,10 @@ "libraryName": "metro-transform-worker", "asOfVersion": "0.76.3" }, + "meyda": { + "libraryName": "meyda", + "asOfVersion": "5.3.0" + }, "micro": { "libraryName": "micro", "asOfVersion": "10.0.0" @@ -3685,6 +3869,10 @@ "libraryName": "mri", "asOfVersion": "1.2.0" }, + "mrz": { + "libraryName": "mrz", + "asOfVersion": "3.2.0" + }, "msportalfx-test": { "libraryName": "msportalfx-test", "asOfVersion": "0.7.2" @@ -3837,6 +4025,10 @@ "libraryName": "node-json-db", "asOfVersion": "0.9.2" }, + "node-mailjet": { + "libraryName": "node-mailjet", + "asOfVersion": "4.0.0" + }, "node-pg-migrate": { "libraryName": "node-pg-migrate", "asOfVersion": "2.15.0" @@ -3845,6 +4037,10 @@ "libraryName": "node-sql-parser", "asOfVersion": "1.1.0" }, + "node-ssh": { + "libraryName": "node-ssh", + "asOfVersion": "11.0.0" + }, "node-vault": { "libraryName": "node-vault", "asOfVersion": "0.9.13" @@ -3977,6 +4173,10 @@ "libraryName": "openid-client", "asOfVersion": "3.7.0" }, + "openpgp": { + "libraryName": "openpgp", + "asOfVersion": "5.0.0" + }, "opn": { "libraryName": "opn", "asOfVersion": "5.5.0" @@ -4177,6 +4377,10 @@ "libraryName": "package-json", "asOfVersion": "6.1.0" }, + "package-json-validator": { + "libraryName": "package-json-validator", + "asOfVersion": "0.8.0" + }, "pad": { "libraryName": "pad", "asOfVersion": "2.1.0" @@ -4295,6 +4499,10 @@ "libraryName": "phin", "asOfVersion": "3.4.0" }, + "phone": { + "libraryName": "phone", + "asOfVersion": "3.0.0" + }, "phonegap-plugin-push": { "libraryName": "phonegap-plugin-push", "asOfVersion": "2.1.2" @@ -4375,6 +4583,10 @@ "libraryName": "png-img", "asOfVersion": "4.0.4" }, + "podcast": { + "libraryName": "podcast", + "asOfVersion": "2.0.0" + }, "pollyjs__adapter": { "libraryName": "@pollyjs/adapter", "asOfVersion": "6.0.4" @@ -4623,6 +4835,10 @@ "libraryName": "qrcode-generator", "asOfVersion": "1.0.6" }, + "qrcode.react": { + "libraryName": "qrcode.react", + "asOfVersion": "3.0.0" + }, "quadstore": { "libraryName": "quadstore", "asOfVersion": "8.0.0" @@ -4679,6 +4895,10 @@ "libraryName": "randoma", "asOfVersion": "1.3.0" }, + "range_check": { + "libraryName": "range_check", + "asOfVersion": "2.0.0" + }, "raspi": { "libraryName": "raspi", "asOfVersion": "5.0.1" @@ -4851,6 +5071,10 @@ "libraryName": "react-bootstrap-range-slider", "asOfVersion": "3.0.0" }, + "react-bootstrap-typeahead": { + "libraryName": "react-bootstrap-typeahead", + "asOfVersion": "6.0.0" + }, "react-calendar": { "libraryName": "react-calendar", "asOfVersion": "4.1.0" @@ -4891,6 +5115,14 @@ "libraryName": "react-countup", "asOfVersion": "4.3.1" }, + "react-cropper": { + "libraryName": "react-cropper", + "asOfVersion": "2.0.0" + }, + "react-custom-scroll": { + "libraryName": "react-custom-scroll", + "asOfVersion": "7.0.0" + }, "react-datepicker": { "libraryName": "react-datepicker", "asOfVersion": "7.0.0" @@ -4999,6 +5231,10 @@ "libraryName": "react-inlinesvg", "asOfVersion": "1.0.0" }, + "react-inspector": { + "libraryName": "react-inspector", + "asOfVersion": "6.0.1" + }, "react-interactive": { "libraryName": "react-interactive", "asOfVersion": "1.0.0" @@ -5027,6 +5263,10 @@ "libraryName": "react-leaflet", "asOfVersion": "3.0.0" }, + "react-leaflet-markercluster": { + "libraryName": "react-leaflet-markercluster", + "asOfVersion": "4.2.1" + }, "react-loader-spinner": { "libraryName": "react-loader-spinner", "asOfVersion": "4.0.0" @@ -5107,6 +5347,10 @@ "libraryName": "react-native-linear-gradient", "asOfVersion": "2.4.0" }, + "react-native-loading-spinner-overlay": { + "libraryName": "react-native-loading-spinner-overlay", + "asOfVersion": "3.0.0" + }, "react-native-mail": { "libraryName": "react-native-mail", "asOfVersion": "6.0.1" @@ -5167,6 +5411,10 @@ "libraryName": "react-native-tab-view", "asOfVersion": "2.3.0" }, + "react-native-text-input-mask": { + "libraryName": "react-native-text-input-mask", + "asOfVersion": "3.0.0" + }, "react-native-touch-id": { "libraryName": "react-native-touch-id", "asOfVersion": "4.4.0" @@ -5223,6 +5471,10 @@ "libraryName": "react-resize-detector", "asOfVersion": "6.1.0" }, + "react-responsive": { + "libraryName": "react-responsive", + "asOfVersion": "9.0.0" + }, "react-rnd": { "libraryName": "react-rnd", "asOfVersion": "8.0.0" @@ -5555,6 +5807,10 @@ "libraryName": "rollup-plugin-sourcemaps", "asOfVersion": "0.5.0" }, + "rollup__plugin-virtual": { + "libraryName": "@rollup/plugin-virtual", + "asOfVersion": "3.0.0" + }, "rot-js": { "libraryName": "rot-js", "asOfVersion": "2.0.1" @@ -5591,6 +5847,10 @@ "libraryName": "sade", "asOfVersion": "1.8.0" }, + "safe-regex-test": { + "libraryName": "safe-regex-test", + "asOfVersion": "1.1.0" + }, "samchon": { "libraryName": "samchon", "asOfVersion": "2.0.22" @@ -5611,6 +5871,10 @@ "libraryName": "sass", "asOfVersion": "1.45.0" }, + "sass-true": { + "libraryName": "sass-true", + "asOfVersion": "6.1.0" + }, "sass-webpack-plugin": { "libraryName": "sass-webpack-plugin", "asOfVersion": "1.0.2" @@ -5775,6 +6039,10 @@ "libraryName": "slice-ansi", "asOfVersion": "7.1.0" }, + "slonik": { + "libraryName": "slonik", + "asOfVersion": "23.0.0" + }, "smooth-scrollbar": { "libraryName": "smooth-scrollbar", "asOfVersion": "8.2.5" @@ -6175,6 +6443,10 @@ "libraryName": "tcomb", "asOfVersion": "2.6.0" }, + "tedious": { + "libraryName": "tedious", + "asOfVersion": "18.0.0" + }, "temp-dir": { "libraryName": "temp-dir", "asOfVersion": "2.0.0" @@ -6315,6 +6587,10 @@ "libraryName": "ts3-nodejs-library", "asOfVersion": "2.0.0" }, + "tsc-watch": { + "libraryName": "tsc-watch", + "asOfVersion": "6.0.0" + }, "tsmonad": { "libraryName": "tsmonad", "asOfVersion": "0.5.0" @@ -6379,6 +6655,10 @@ "libraryName": "uk.co.workingedge.phonegap.plugin.launchnavigator", "asOfVersion": "4.0.0" }, + "unbox-primitive": { + "libraryName": "unbox-primitive", + "asOfVersion": "1.1.0" + }, "unique-random": { "libraryName": "unique-random", "asOfVersion": "2.1.0" @@ -6619,6 +6899,10 @@ "libraryName": "webpack-dev-server", "asOfVersion": "4.7.0" }, + "webpack-manifest-plugin": { + "libraryName": "webpack-manifest-plugin", + "asOfVersion": "4.0.0" + }, "webpack-merge": { "libraryName": "webpack-merge", "asOfVersion": "5.0.0" @@ -6639,6 +6923,10 @@ "libraryName": "typescript", "asOfVersion": "3.2.1" }, + "which-boxed-primitive": { + "libraryName": "which-boxed-primitive", + "asOfVersion": "v1.1.0" + }, "which-pm": { "libraryName": "which-pm", "asOfVersion": "1.1.0" @@ -6811,6 +7099,10 @@ "libraryName": "@wordpress/rich-text", "asOfVersion": "6.10.0" }, + "wordpress__shortcode": { + "libraryName": "@wordpress/shortcode", + "asOfVersion": "4.14.0" + }, "wordpress__token-list": { "libraryName": "@wordpress/token-list", "asOfVersion": "1.10.0" @@ -6931,6 +7223,10 @@ "libraryName": "xml-js", "asOfVersion": "1.0.0" }, + "xml-zero-lexer": { + "libraryName": "xml-zero-lexer", + "asOfVersion": "3.1.8" + }, "xmlbuilder": { "libraryName": "xmlbuilder", "asOfVersion": "11.0.1" diff --git a/package.json b/package.json index d45d79515dbd580..1615326f103a07a 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ "@definitelytyped/typescript-versions": "latest", "@definitelytyped/utils": "latest", "danger": "^11.2.3", - "dprint": "^0.47.2", + "dprint": "^0.49.0", "eslint-plugin-jsdoc": "^44.2.7", "husky": "^8.0.3", "lint-staged": "^15.2.0", diff --git a/types/agent-base/agent-base-tests.ts b/types/agent-base/agent-base-tests.ts deleted file mode 100644 index c48a5d86f1766aa..000000000000000 --- a/types/agent-base/agent-base-tests.ts +++ /dev/null @@ -1,34 +0,0 @@ -import agent = require("agent-base"); - -agent(); // $ExpectType Agent -agent({ timeout: 1000 }); // $ExpectType Agent - -agent((req, opts) => {}); // $ExpectType Agent -agent((req, opts) => {}, { timeout: 1000 }); // $ExpectType Agent - -agent(async (req, opts) => {}); // $ExpectType Agent -agent(async (req, opts) => {}, { timeout: 1000 }); // $ExpectType Agent - -// @ts-expect-error -agent(0); -// @ts-expect-error -agent(1); -// @ts-expect-error -agent(""); -// @ts-expect-error -agent(true); -// @ts-expect-error -agent(null); - -// @ts-expect-error -agent((req, opts) => {}, 0); -// @ts-expect-error -agent((req, opts) => {}, 1); -// @ts-expect-error -agent((req, opts) => {}, ""); -// @ts-expect-error -agent((req, opts) => {}, true); -// @ts-expect-error -agent((req, opts) => {}, null); -// @ts-expect-error -agent((req, opts) => {}, (req, opts) => {}); diff --git a/types/agent-base/index.d.ts b/types/agent-base/index.d.ts deleted file mode 100644 index 418fce47f32977d..000000000000000 --- a/types/agent-base/index.d.ts +++ /dev/null @@ -1,39 +0,0 @@ -/// -import { EventEmitter } from "events"; - -declare namespace Agent { - type AgentCallback = ( - req?: any, - opts?: { - secureEndpoint: boolean; - }, - ) => void; - - interface AgentOptions { - timeout?: number | undefined; - host?: string | undefined; - port?: number | undefined; - [key: string]: any; - } - - interface Agent extends EventEmitter { - _promisifiedCallback: boolean; - timeout: number | null; - options?: AgentOptions | undefined; - callback: AgentCallback; - addRequest: (req?: any, opts?: any) => void; - freeSocket: (socket: any, opts: any) => void; - } -} - -/** - * Base `http.Agent` implementation. - * No pooling/keep-alive is implemented by default. - */ -declare function Agent(opts?: Agent.AgentOptions): Agent.Agent; -declare function Agent( - callback: Agent.AgentCallback, - opts?: Agent.AgentOptions, -): Agent.Agent; - -export = Agent; diff --git a/types/agent-base/package.json b/types/agent-base/package.json deleted file mode 100644 index 20cd68281d5e087..000000000000000 --- a/types/agent-base/package.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "private": true, - "name": "@types/agent-base", - "version": "4.2.9999", - "projects": [ - "https://github.com/TooTallNate/node-agent-base#readme" - ], - "dependencies": { - "@types/node": "*" - }, - "devDependencies": { - "@types/agent-base": "workspace:." - }, - "owners": [ - { - "name": "Christopher Quadflieg", - "githubUsername": "Shinigami92" - } - ] -} diff --git a/types/agent-base/tsconfig.json b/types/agent-base/tsconfig.json deleted file mode 100644 index 9884eea1d2f79c8..000000000000000 --- a/types/agent-base/tsconfig.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "compilerOptions": { - "module": "node16", - "target": "es6", - "lib": [ - "es6" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": true, - "strictFunctionTypes": true, - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "agent-base-tests.ts" - ] -} diff --git a/types/akamai-edgeworkers/index.d.ts b/types/akamai-edgeworkers/index.d.ts index 0e6789b32732ee0..41461b2a12ff0d4 100644 --- a/types/akamai-edgeworkers/index.d.ts +++ b/types/akamai-edgeworkers/index.d.ts @@ -16,6 +16,14 @@ declare namespace EW { } interface ReadAllHeader { + /** + * Returns a JavaScript object that contains the HTTP headers + * as properties. + * + * The key for each property is the name of the HTTP header, + * normalized to lower-case. The value is an array of strings, + * containing one string for each HTTP header with the same name. + */ getHeaders(): Headers; } @@ -464,7 +472,7 @@ declare namespace EW { { } - interface EgressOriginResponse extends MutatesHeaders, ReadsHeaders, HasStatus { + interface EgressOriginResponse extends MutatesHeaders, ReadsHeaders, ReadAllHeader, HasStatus { } // onClientResponse @@ -473,7 +481,7 @@ declare namespace EW { { } - interface EgressClientResponse extends MutatesHeaders, ReadsHeaders, HasStatus { + interface EgressClientResponse extends MutatesHeaders, ReadsHeaders, ReadAllHeader, HasStatus { } // responseProvider diff --git a/types/akamai-edgeworkers/test/akamai-edgeworkers-global.test.ts b/types/akamai-edgeworkers/test/akamai-edgeworkers-global.test.ts index e4ba71b0ffc220d..b25e64e19b8a9ed 100644 --- a/types/akamai-edgeworkers/test/akamai-edgeworkers-global.test.ts +++ b/types/akamai-edgeworkers/test/akamai-edgeworkers-global.test.ts @@ -91,6 +91,9 @@ export function onOriginResponse(request: EW.EgressOriginRequest, response: EW.E } response.removeHeader("onOriginResponse-removeHeader-resp-bye"); + // Resp- getHeaders + testHeaders(response.getHeaders()); + // EW.EgressOriginRequest.getHeaders() testHeaders(request.getHeaders()); @@ -143,6 +146,8 @@ export function onClientResponse(request: EW.EgressClientRequest, response: EW.E } response.removeHeader("onClientResponse-removeHeader-resp-bye"); + testHeaders(response.getHeaders()); + // EW.EgressClientRequest.getHeaders() testHeaders(request.getHeaders()); @@ -172,6 +177,7 @@ export function responseProvider(request: EW.ResponseProviderRequest) { const arrayBufferBody = request.arrayBuffer(); } +// Verify the headers object function testHeaders(headers: EW.Headers) { Object.keys(headers).forEach(key => { key.toUpperCase(); diff --git a/types/animejs/index.d.ts b/types/animejs/index.d.ts index 34d169ee4c48824..046a9271ce980b4 100644 --- a/types/animejs/index.d.ts +++ b/types/animejs/index.d.ts @@ -141,6 +141,7 @@ declare namespace anime { // Helpers const version: string; const speed: number; + let suspendWhenDocumentHidden: boolean; const running: AnimeInstance[]; const easings: { [EasingFunction: string]: (t: number) => any }; function remove(targets: AnimeTarget | readonly AnimeTarget[]): void; diff --git a/types/apicache/apicache-tests.ts b/types/apicache/apicache-tests.ts index fcf6109262ae45d..8238a6e03fd8efc 100644 --- a/types/apicache/apicache-tests.ts +++ b/types/apicache/apicache-tests.ts @@ -1,4 +1,4 @@ -import { middleware, newInstance, options } from "apicache"; +import { clear, middleware, newInstance, options } from "apicache"; let cache = middleware; @@ -11,6 +11,8 @@ options({ options(); +clear(); + cache = newInstance({ statusCodes: { exclude: [404, 429, 500], diff --git a/types/apicache/index.d.ts b/types/apicache/index.d.ts index 71704fe48abdb15..b8944e2132a5f7b 100644 --- a/types/apicache/index.d.ts +++ b/types/apicache/index.d.ts @@ -6,7 +6,7 @@ export const id: number; /** * clears cache target (key or group), or entire cache if no value passed, returns new index. */ -export function clear(target: string | any[]): any; +export function clear(target?: string | any[]): any; /** used to create a new ApiCache instance with the same options as the current one */ export function clone(): any; diff --git a/types/appdynamics/appdynamics-tests.ts b/types/appdynamics/appdynamics-tests.ts index d8d87eb7c5667a6..ac098e3815bcc70 100644 --- a/types/appdynamics/appdynamics-tests.ts +++ b/types/appdynamics/appdynamics-tests.ts @@ -7,4 +7,32 @@ appdynamics.profile({ controllerSslEnabled: true, tierName: "tier-name", nodeName: "node-name", + accountName: "account-name", + accountAccessKey: "account-key", + applicationName: "your_app_name", + noNodeNameSuffix: false, + alwaysAddEumMetadataInHttpHeaders: true, + btEntryPointDelayDisabled: false, + debug: true, + logging: { + logfiles: [ + { + root_directory: "/some/root/path", + filename: "somename.log", + level: "INFO", + max_size: 123456, + max_file: 5, + outputType: "console", + }, + ], + }, + maxProcessSnapshotsPerPeriod: 10, + processSnapshotPeriodInSeconds: 60, + autoSnapshotDurationSeconds: 30, + rootTmpDir: "/some/root/temp/path", + tmpDir: "/some/tmp/path", + reuseNode: true, + reuseNodePrefix: "some-prefix", + certificateFile: "/some/certificate/path", + uniqueHostId: "unique-host-id", }); diff --git a/types/appdynamics/index.d.ts b/types/appdynamics/index.d.ts index 5bcf4bbb024e878..b0b1281c5f841c3 100644 --- a/types/appdynamics/index.d.ts +++ b/types/appdynamics/index.d.ts @@ -12,6 +12,32 @@ export interface ProfileParameter { controllerHostName?: string; controllerPort?: number; controllerSslEnabled?: boolean; + accountName?: string; + accountAccessKey?: string; + applicationName?: string; tierName?: string; nodeName?: string; + noNodeNameSuffix?: boolean; + alwaysAddEumMetadataInHttpHeaders?: boolean; + btEntryPointDelayDisabled?: boolean; + debug?: boolean; + logging?: { + logfiles?: Array<{ + root_directory?: string; + filename?: string; + level?: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"; + max_size?: number; + max_file?: number; + outputType?: string; + }>; + }; + maxProcessSnapshotsPerPeriod?: number; + processSnapshotPeriodInSeconds?: number; + autoSnapshotDurationSeconds?: number; + rootTmpDir?: string; + tmpDir?: string; + reuseNode?: boolean; + reuseNodePrefix?: string; + certificateFile?: string; + uniqueHostId?: string; } diff --git a/types/appdynamics/package.json b/types/appdynamics/package.json index 3996222fe403594..3f129a7c8e10529 100644 --- a/types/appdynamics/package.json +++ b/types/appdynamics/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/appdynamics", - "version": "21.8.9999", + "version": "24.10.9999", "projects": [ "https://www.appdynamics.com/supported-technologies/nodejs" ], diff --git a/types/asciify/.eslintrc.json b/types/asciify/.eslintrc.json deleted file mode 100644 index a4d801905a9ca6a..000000000000000 --- a/types/asciify/.eslintrc.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "rules": { - "@definitelytyped/no-declare-current-package": "off", - "@definitelytyped/no-single-declare-module": "off" - } -} diff --git a/types/asciify/asciify-tests.ts b/types/asciify/asciify-tests.ts index db5bedeea5b882a..835c83b7009d637 100644 --- a/types/asciify/asciify-tests.ts +++ b/types/asciify/asciify-tests.ts @@ -1,15 +1,33 @@ -import asciify = require("asciify"); +import asciify from "asciify"; +// $ExpectType void asciify("Whoa", function(err, result) { - console.log(result); + // $ExpectType any + err; + // $ExpectType string + result; }); + +// $ExpectType void asciify("Whoa", "3-d", function(err, result) { - console.log(result); + // $ExpectType any + err; + // $ExpectType string + result; }); + +// $ExpectType void asciify("Whoa", { font: "3-d" }, function(err, result) { - console.log(result); + // $ExpectType any + err; + // $ExpectType string + result; }); +// $ExpectType void asciify.getFonts(function(err, fonts) { - fonts.slice(0); + // $ExpectType Error + err; + // $ExpectType string[] + fonts; }); diff --git a/types/asciify/index.d.ts b/types/asciify/index.d.ts index 204bcf1a18caa85..c091644a4070c03 100644 --- a/types/asciify/index.d.ts +++ b/types/asciify/index.d.ts @@ -1,24 +1,20 @@ -/// +declare namespace asciify { + function getFonts(callback: (err: Error, fonts: string[]) => void): void; -interface AsciifyOptions { - font?: string | undefined; - maxWidth?: number | undefined; - color?: string | undefined; -} + interface AsciifyOptions { + font?: string | undefined; + maxWidth?: number | undefined; + color?: string | undefined; + } -interface AsciifyCallback { - // err is sometimes a string and sometimes an Error - (err: any, asciifiedText: string): void; + interface AsciifyCallback { + // err is sometimes a string and sometimes an Error + (err: any, asciifiedText: string): void; + } } -declare module "asciify" { - function asciify(text: string, callback: AsciifyCallback): void; - function asciify(text: string, options: string, callback: AsciifyCallback): void; - function asciify(text: string, options: AsciifyOptions, callback: AsciifyCallback): void; +declare function asciify(text: string, callback: asciify.AsciifyCallback): void; +declare function asciify(text: string, options: string, callback: asciify.AsciifyCallback): void; +declare function asciify(text: string, options: asciify.AsciifyOptions, callback: asciify.AsciifyCallback): void; - namespace asciify { - function getFonts(callback: (err: Error, fonts: string[]) => void): void; - } - - export = asciify; -} +export = asciify; diff --git a/types/asciify/package.json b/types/asciify/package.json index 435166c31e7721c..aa1ba59c982ab1b 100644 --- a/types/asciify/package.json +++ b/types/asciify/package.json @@ -5,9 +5,6 @@ "projects": [ "https://www.npmjs.org/package/asciify" ], - "dependencies": { - "@types/node": "*" - }, "devDependencies": { "@types/asciify": "workspace:." }, diff --git a/types/agent-base/.npmignore b/types/async-alpine/.npmignore similarity index 100% rename from types/agent-base/.npmignore rename to types/async-alpine/.npmignore diff --git a/types/async-alpine/async-alpine-tests.ts b/types/async-alpine/async-alpine-tests.ts new file mode 100644 index 000000000000000..a127c451516f27e --- /dev/null +++ b/types/async-alpine/async-alpine-tests.ts @@ -0,0 +1,47 @@ +/** + * Typescript definition tests for async-alpine module + * + * Note: These tests are intended to test the definitions only + * in the sense of typing and call signature consistency. They + * are not intended as functional tests. + */ + +import Alpine, { type DirectiveCallback } from "alpinejs"; +import AsyncAlpine, { type AlpineAsyncOptions } from "async-alpine"; + +// init plugin +Alpine.plugin(AsyncAlpine); + +// setup options +const options: AlpineAsyncOptions = { + defaultStrategy: "idle", + keepRelativeURLs: false, +}; +Alpine.asyncOptions(options); + +// listen plugin events +window.addEventListener("async-alpine:load", (event) => { + console.log("async-alpine:load", event.detail.id); +}); + +// usage: data +Alpine.asyncData( + "myComponent", + () => import("./async-alpine_async-component-tests.js"), +); + +// usage: url +Alpine.asyncUrl("myComponent", "./async-alpine_async-component-tests.ts"); + +// usage: alias +Alpine.asyncAlias("./[name].ts"); +Alpine.asyncAlias((name) => import(`/${name}.ts`)); + +// directive with async data +function directive(): DirectiveCallback { + return (el) => { + el._x_async = "init"; + el._x_async = undefined; + }; +} +directive(); diff --git a/types/async-alpine/async-alpine_async-component-tests.ts b/types/async-alpine/async-alpine_async-component-tests.ts new file mode 100644 index 000000000000000..7db73659274d4c3 --- /dev/null +++ b/types/async-alpine/async-alpine_async-component-tests.ts @@ -0,0 +1,13 @@ +interface ComponentState { + message: string; + init(): void; +} + +export default function myComponent(): ComponentState { + return { + message: "", + init() { + this.message = "my component has initialised!"; + }, + }; +} diff --git a/types/async-alpine/index.d.ts b/types/async-alpine/index.d.ts new file mode 100644 index 000000000000000..0431ef4a7ddbdc0 --- /dev/null +++ b/types/async-alpine/index.d.ts @@ -0,0 +1,31 @@ +import type { AlpineComponent, PluginCallback } from "alpinejs"; + +declare global { + interface WindowEventMap { + "async-alpine:load": CustomEvent<{ id: string }>; + } +} + +export interface AlpineAsyncOptions { + defaultStrategy?: "eager" | "idle" | "visible" | string; + keepRelativeURLs?: boolean; +} + +declare module "alpinejs" { + interface Alpine { + asyncOptions(opts: AlpineAsyncOptions): void; + asyncData( + name: string, + download: (name: string) => AlpineComponent, + ): void; + asyncUrl(name: string, url: string): void; + asyncAlias(path: string | ((name: string) => any)): void; + } + + interface XAttributes { + _x_async: "init" | "await" | "loaded"; + } +} + +declare const asyncAlpinePlugin: PluginCallback; +export default asyncAlpinePlugin; diff --git a/types/async-alpine/package.json b/types/async-alpine/package.json new file mode 100644 index 000000000000000..65d64de8bec18b8 --- /dev/null +++ b/types/async-alpine/package.json @@ -0,0 +1,21 @@ +{ + "private": true, + "type": "module", + "name": "@types/async-alpine", + "version": "2.0.9999", + "projects": [ + "https://github.com/Accudio/async-alpine" + ], + "dependencies": { + "@types/alpinejs": "*" + }, + "devDependencies": { + "@types/async-alpine": "workspace:." + }, + "owners": [ + { + "name": "Bastien Robert", + "githubUsername": "bastienrobert" + } + ] +} diff --git a/types/consul/tsconfig.json b/types/async-alpine/tsconfig.json similarity index 83% rename from types/consul/tsconfig.json rename to types/async-alpine/tsconfig.json index 2e4d726e7f3858f..6aedcbc1c7a884b 100644 --- a/types/consul/tsconfig.json +++ b/types/async-alpine/tsconfig.json @@ -15,6 +15,7 @@ }, "files": [ "index.d.ts", - "consul-tests.ts" + "async-alpine-tests.ts", + "async-alpine_async-component-tests.ts" ] } diff --git a/types/autocannon/autocannon-tests.ts b/types/autocannon/autocannon-tests.ts index 7d87a19928095f5..9c19dd7d2860df4 100644 --- a/types/autocannon/autocannon-tests.ts +++ b/types/autocannon/autocannon-tests.ts @@ -77,3 +77,4 @@ instance.on("response", (client, statusCode, resBytes, responseTime) => { instance.on("done", result => console.log(result.throughput.p99_99)); instance.on("error", err => console.error(err)); instance.on("reqError", err => console.error(err)); +instance.stop(); diff --git a/types/autocannon/index.d.ts b/types/autocannon/index.d.ts index 73acda556dbae52..4d6d05de72109af 100644 --- a/types/autocannon/index.d.ts +++ b/types/autocannon/index.d.ts @@ -304,6 +304,11 @@ declare namespace autocannon { * Emitted if there is an error during the setup phase of autocannon. */ on(event: "error", listener: (err: any) => void): this; // tslint:disable-line:unified-signatures + + /** + * Stop autocannon. + */ + stop(): void; } /** diff --git a/types/awesome-notifications/awesome-notifications-tests.ts b/types/awesome-notifications/awesome-notifications-tests.ts index 577b0395370bf4b..9198a278b5cb158 100644 --- a/types/awesome-notifications/awesome-notifications-tests.ts +++ b/types/awesome-notifications/awesome-notifications-tests.ts @@ -1,6 +1,12 @@ import AWN = require("awesome-notifications"); -const awn = new AWN(); +const awn = new AWN({ + icons: { + enabled: true, + prefix: "", + suffix: "", + }, +}); const confirmed = () => console.log("Confirmed"); const cancelled = () => console.log("Cancelled"); diff --git a/types/awesome-notifications/index.d.ts b/types/awesome-notifications/index.d.ts index 95d4985db34ef0b..4b7dca61590e380 100644 --- a/types/awesome-notifications/index.d.ts +++ b/types/awesome-notifications/index.d.ts @@ -24,7 +24,20 @@ declare namespace AWN { type AwnIconOptions = & Omit, "global"> & Omit, "async-block"> - & { enabled?: boolean }; + & { + /** + * Defines visibility of icons for all toasts and popups. + */ + enabled?: boolean; + /** + * Used internally to create first part of icon element. + */ + prefix?: string; + /** + * Used internally to create second part of icon element. + */ + suffix?: string; + }; type AwnLabelOptions = & Omit, "global"> diff --git a/types/aws-lambda/trigger/guard-duty-event-notification.d.ts b/types/aws-lambda/trigger/guard-duty-event-notification.d.ts index 0a59a7f421eb0ea..dc7e84b1f81e079 100644 --- a/types/aws-lambda/trigger/guard-duty-event-notification.d.ts +++ b/types/aws-lambda/trigger/guard-duty-event-notification.d.ts @@ -19,7 +19,7 @@ export interface GuardDutyScanResultNotificationEventDetail { s3ObjectDetails: { bucketName: string; objectKey: string; - etag: string; + eTag: string; versionId: string; s3Throttled: boolean; }; diff --git a/types/babel__preset-env/babel__preset-env-tests.ts b/types/babel__preset-env/babel__preset-env-tests.ts index a793eaa567f59a2..b86ee77195bc942 100644 --- a/types/babel__preset-env/babel__preset-env-tests.ts +++ b/types/babel__preset-env/babel__preset-env-tests.ts @@ -269,3 +269,15 @@ options = { options = { shippedProposals: false, }; + +// ===================// +// BROWSERSLIST ENV // +// ===================// + +options = { + browserslistEnv: "production", +}; + +options = { + browserslistEnv: "dev", +}; diff --git a/types/babel__preset-env/index.d.ts b/types/babel__preset-env/index.d.ts index 9cf5f7666dcd43d..21cfb55b7ce2641 100644 --- a/types/babel__preset-env/index.d.ts +++ b/types/babel__preset-env/index.d.ts @@ -13,6 +13,13 @@ export interface Options { configPath?: string | undefined; ignoreBrowserslistConfig?: boolean | undefined; shippedProposals?: boolean | undefined; + /** + * The Browserslist environment to use. + * Added in v7.10.0. + * + * See {@link https://babeljs.io/docs/babel-preset-env.html#browserslistenv} + */ + browserslistEnv?: string | undefined; } /** diff --git a/types/babel__preset-env/package.json b/types/babel__preset-env/package.json index c8f98c3a0bfb30f..bd2234ea868b06e 100644 --- a/types/babel__preset-env/package.json +++ b/types/babel__preset-env/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/babel__preset-env", - "version": "7.9.9999", + "version": "7.10.9999", "projects": [ "https://github.com/babel/babel/tree/master/packages/babel-preset-env", "https://babeljs.io/docs/en/babel-preset-env" diff --git a/types/baidu-aip-sdk/AipContentCensor.d.ts b/types/baidu-aip-sdk/AipContentCensor.d.ts index e64f3c66830e2a2..aab6530eaef07f0 100644 --- a/types/baidu-aip-sdk/AipContentCensor.d.ts +++ b/types/baidu-aip-sdk/AipContentCensor.d.ts @@ -1,4 +1,6 @@ export = AipImageCensor; +import { ImageCensorUserDefinedResult } from "./AipContentCensorType"; + /** * AipContentCensor类，构造调用图像审核对象 * @@ -10,7 +12,7 @@ declare class AipImageCensor extends BaseClient { constructor(appId: string, ak: string, sk: string); commonImpl(param: any): any; jsonRequestImpl(param: any): any; - imageCensorUserDefined(image: any, type: any): any; + imageCensorUserDefined(image: string, type: "url" | "base64"): Promise; textCensorUserDefined(text: any, type: any): any; report(feedback: any): any; } diff --git a/types/baidu-aip-sdk/AipContentCensorType.d.ts b/types/baidu-aip-sdk/AipContentCensorType.d.ts new file mode 100644 index 000000000000000..954c9208174b6ce --- /dev/null +++ b/types/baidu-aip-sdk/AipContentCensorType.d.ts @@ -0,0 +1,51 @@ +/** + * 图像审核结果 + * @see https://ai.baidu.com/ai-doc/ANTIPORN/Vk42xcpu1 + */ +export interface ImageCensorUserDefinedResult { + log_id: number; + error_code?: number; + err_msg?: string; + conclusion: string; + conclusionType: number; + data: { + error_code?: number; + err_msg?: string; + type: number; + sub_type: number; + msg: string; + probability: number; + datasetName: number; + stars?: { + name: string; + probability: number; + datasetName: string; + area?: string; + information?: string; + }; + hits?: { + words: string[]; + probability: number; + datasetName: string; + modelHitPositions: object[]; + wordHitPositions: { + keyword: string; + positions: number[]; + label: string; + }[]; + modelName: string; + score: number; + modelId: []; + label: string; + }; + codes?: string[]; + location: { + top: number; + left: number; + width: number; + height: number; + rotation: number; + }[]; + }[]; + isHitMd5: boolean; +} diff --git a/types/baidu-aip-sdk/index.d.ts b/types/baidu-aip-sdk/index.d.ts index 403892473217769..aa414fd1369610e 100644 --- a/types/baidu-aip-sdk/index.d.ts +++ b/types/baidu-aip-sdk/index.d.ts @@ -1,10 +1,23 @@ -export let imageprocess: typeof import("./AipImageProcess"); -export let imageSearch: typeof import("./AipImageSearch"); -export let imageClassify: typeof import("./AipImageClassify"); -export let contentCensor: typeof import("./AipContentCensor"); -export let face: typeof import("./AipFace"); -export let ocr: typeof import("./AipOcr"); -export let nlp: typeof import("./AipNlp"); -export let kg: typeof import("./AipKg"); -export let speech: typeof import("./AipSpeech"); -export let HttpClient: typeof import("./http/httpClient"); +import AipImageCensor = require("./AipContentCensor"); +import AipImageProcess = require("./AipImageProcess"); +import AipImageSearch = require("./AipImageSearch"); +import AipImageClassify = require("./AipImageClassify"); +import AipFace = require("./AipFace"); +import AipOcr = require("./AipOcr"); +import AipNlp = require("./AipNlp"); +import AipKg = require("./AipKg"); +import AipSpeech = require("./AipSpeech"); +import HttpClient = require("./http/httpClient"); + +export { + AipFace as face, + AipImageCensor as contentCensor, + AipImageClassify as imageClassify, + AipImageProcess as imageprocess, + AipImageSearch as imageSearch, + AipKg as kg, + AipNlp as nlp, + AipOcr as ocr, + AipSpeech as speech, + HttpClient, +}; diff --git a/types/cache-manager-redis-store/.npmignore b/types/basil.js/.npmignore similarity index 100% rename from types/cache-manager-redis-store/.npmignore rename to types/basil.js/.npmignore diff --git a/types/basil.js/basil.js-tests.ts b/types/basil.js/basil.js-tests.ts new file mode 100644 index 000000000000000..b15c213ea693baf --- /dev/null +++ b/types/basil.js/basil.js-tests.ts @@ -0,0 +1,71 @@ +import Basil = require("basil.js"); + +const basil1 = Basil(); +const basil2 = new Basil(); + +const customOptions: Basil.BasilOptions = { + namespace: "yujiosaka", + storages: ["local", "session", "cookie", "memory"], + keyDelimiter: ":", + raw: false, + expireDays: 7, + domain: "example.com", + secure: true, + sameSite: "lax", +}; + +basil1.init(customOptions); + +basil1.set("stringKey", "stringValue"); +basil1.set("numberKey", 123); +basil1.set("booleanKey", true); + +const strVal: string | null = basil1.get("stringKey"); +const numVal: number | null = basil1.get("numberKey"); +const boolVal: boolean | null = basil1.get("booleanKey"); + +basil1.remove("booleanKey"); + +basil1.reset({ namespace: "myApp" }); +basil1.reset(); + +const allKeys: string[] = basil1.keys(); + +const mapOfKeys = basil1.keysMap(); + +const canUseLocal: boolean = basil1.check("local"); + +if (Basil.localStorage.check()) { + Basil.localStorage.set("localKey", "localValue"); + const localVal: string | null = Basil.localStorage.get("localKey"); + Basil.localStorage.remove("localKey"); + Basil.localStorage.reset(); +} + +if (Basil.sessionStorage.check()) { + Basil.sessionStorage.set("sessionKey", { user: "alice" }); + const sessionVal = Basil.sessionStorage.get<{ user: string }>("sessionKey"); + Basil.sessionStorage.remove("sessionKey"); +} + +if (Basil.memory.check()) { + Basil.memory.set("memKey", [1, 2, 3]); + const memVal = Basil.memory.get("memKey"); + Basil.memory.reset(); +} + +if (Basil.cookie.check({ secure: true })) { + Basil.cookie.set("cookieKey", "cookieValue", { + domain: "example.com", + expireDays: 10, + sameSite: "none", + secure: true, + }); + const cookieVal = Basil.cookie.get("cookieKey"); + Basil.cookie.remove("cookieKey"); +} + +basil2.set([1, "compositeKey"], "value for a composite key"); +const compositeValue = basil2.get([1, "compositeKey"]); + +basil2.setOptions({ namespace: "updatedNamespace" }); diff --git a/types/basil.js/index.d.ts b/types/basil.js/index.d.ts new file mode 100644 index 000000000000000..8013bae26c08b8f --- /dev/null +++ b/types/basil.js/index.d.ts @@ -0,0 +1,255 @@ +/* eslint-disable @definitelytyped/no-unnecessary-generics */ +declare namespace Basil { + /** + * Common Basil options that apply to all storage types + * (local, session, memory, and partially to cookie). + */ + interface BasilCommonOptions { + /** + * A string prefix used for keys in storages. + * e.g. `namespace.keyDelimiter.keyName`. + */ + namespace?: string; + + /** + * List of storages Basil tries, in priority order: + * 'local' | 'cookie' | 'session' | 'memory' + */ + storages?: Array<"local" | "cookie" | "session" | "memory">; + + /** + * Delimiter used between namespace and key. Defaults to '.' + */ + keyDelimiter?: string; + + /** + * If true, Basil stores raw strings (unparsed / unstringified). + * If false, Basil JSON-encodes stored values and JSON-decodes on get(). + */ + raw?: boolean; + } + + /** + * Cookie-specific options. + * These are **only** relevant if you’re using the 'cookie' storage. + */ + interface BasilCookieOptions { + /** + * Number of days until the cookie expires. + * If omitted, it becomes a session cookie (expires on browser close). + */ + expireDays?: number; + + /** + * The domain the cookie is valid for (e.g. 'example.com'). Must match document.domain. + */ + domain?: string; + + /** + * If true, sets the `Secure` flag on the cookie (requires HTTPS). + */ + secure?: boolean; + + /** + * Sets the `SameSite` attribute: 'lax', 'strict', or 'none'. + */ + sameSite?: "lax" | "strict" | "none"; + } + + /** + * Full Basil options = Common + Cookie. + * Non-cookie storages will just ignore cookie-specific fields. + */ + type BasilOptions = BasilCommonOptions & BasilCookieOptions; + + /** + * A minimal interface for storages used by Basil: local, session, memory. + * They support `check`, `set`, `get`, `remove`, etc. + * + * This base interface expects **common** options. + * (Cookie usage can extend this for cookie-specific fields.) + */ + interface BasilStorage { + /** + * Check if the storage is accessible/usable. + * For local/session, tries writing a test key. + * For memory, always true. + * For cookie, we override it with a cookie-specific signature. + */ + check(options?: BasilCommonOptions): boolean; + + /** + * Store a raw string. (No JSON handling.) + * Cookie usage might read domain/secure/sameSite from the options if extended. + */ + set(key: string, value: T, options?: BasilCommonOptions): void; + + /** + * Retrieve a raw string, or null if not found. + */ + get(key: string): T | null; + + /** + * Remove a value by key from this storage alone. + */ + remove(key: string): void; + + /** + * Reset/clear items from this storage. If `namespace` is given, + * only items starting with `namespace + keyDelimiter` are cleared. + */ + reset(namespace?: string): void; + + /** + * Get an array of keys in this storage. If a namespace is provided, + * only keys within that namespace are returned (with the namespace stripped). + */ + keys(namespace?: string, delimiter?: string): string[]; + } + + /** + * Extended storage that handles **cookie-specific** options in `check` and `set`. + * By default, Basil.cookie uses these extra fields. + */ + interface BasilCookieStorage extends Omit { + /** + * For cookies, we accept cookie-specific fields in addition to common fields. + */ + check(options?: BasilOptions): boolean; + + /** + * Setting a cookie can use domain, secure, sameSite, expireDays, etc. + */ + set(key: string, value: T, options?: BasilOptions): void; + } + + /** + * Basil’s main instance (returned by `Basil()` or `new Basil()`). + * Manages reading/writing to multiple storages behind a single API. + */ + interface BasilInstance { + /** + * Basil merges final options (global + user-provided) into `this.options`. + */ + options: BasilOptions; + + /** + * Initialize Basil with new or updated options. + * Usually called internally, but can be re-called to override existing options. + */ + init(options?: BasilOptions): this; + + /** + * Update the Basil instance’s `options`. + */ + setOptions(options?: BasilOptions): void; + + /** + * Check if the named storage is *currently available*. + * e.g. 'local' => localStorage, 'cookie' => cookies, etc. + */ + check(storage: "local" | "cookie" | "session" | "memory"): boolean; + + /** + * Returns `true` if Basil knows about the named storage. + * (Does **not** guarantee availability in the current environment—use `check`.) + */ + support(storage: "local" | "cookie" | "session" | "memory"): boolean; + + /** + * Store a value by key, using the first available storage. + * If `raw` is false, Basil JSON-encodes `value`. If `raw` is true, stores it as a string. + * Returns `true` if *any* storage succeeded, otherwise `false`. + */ + set( + key: + | string + | number + | boolean + | null + | (string | number | boolean | null)[], + value: T, + options?: BasilOptions, + ): boolean; + + /** + * Retrieve a value by key from the configured storages, returning + * the first match. If not found, returns `null`. + * If `raw` is false, Basil attempts JSON-decoding, else returns the raw string. + */ + get( + key: + | string + | number + | boolean + | null + | (string | number | boolean | null)[], + options?: BasilOptions, + ): T | null; + + /** + * Remove a key from all configured storages that contain it. + */ + remove( + key: + | string + | number + | boolean + | null + | (string | number | boolean | null)[], + options?: BasilOptions, + ): void; + + /** + * Reset (clear) keys in all configured storages. + * If `namespace` is specified in `options`, only that namespace is cleared. + */ + reset(options?: BasilOptions): void; + + /** + * Return an array of keys known to Basil in all configured storages. + * If `namespace` is in `options`, only those matching are returned. + */ + keys(options?: BasilOptions): string[]; + + /** + * Return a map of keys => storages that contain them. + * e.g. `{ foo: ['local'], abc: ['cookie', 'memory'] }`. + */ + keysMap( + options?: BasilOptions, + ): Record>; + } + + /** + * The Basil constructor/function can be called as `new Basil(...)` or `Basil(...)`. + * It also exposes the **raw** storage objects for direct usage. + */ + interface BasilConstructor { + /** + * Call Basil as a constructor: `new Basil({ ... })` + */ + new(options?: BasilOptions): BasilInstance; + + /** + * Call Basil as a function: `Basil({ ... })` + */ + (options?: BasilOptions): BasilInstance; + + /** + * Direct references to each storage: + * - Basil.cookie: uses cookie-specific `check(...)` and `set(...)` + * - Basil.localStorage / Basil.sessionStorage / Basil.memory: use the generic interface + */ + cookie: BasilCookieStorage; + localStorage: BasilStorage; + sessionStorage: BasilStorage; + memory: BasilStorage; + } +} + +declare const Basil: Basil.BasilConstructor; + +export as namespace Basil; + +export = Basil; diff --git a/types/basil.js/package.json b/types/basil.js/package.json new file mode 100644 index 000000000000000..03bdfa071d34559 --- /dev/null +++ b/types/basil.js/package.json @@ -0,0 +1,17 @@ +{ + "private": true, + "name": "@types/basil.js", + "version": "0.4.9999", + "projects": [ + "https://github.com/Wisembly/basil.js" + ], + "devDependencies": { + "@types/basil.js": "workspace:." + }, + "owners": [ + { + "name": "Yuji Isobe", + "githubUsername": "yujiosaka" + } + ] +} diff --git a/types/hexo/tsconfig.json b/types/basil.js/tsconfig.json similarity index 93% rename from types/hexo/tsconfig.json rename to types/basil.js/tsconfig.json index 1a0f1a29abb22f1..f9ebe7d8bccaa69 100644 --- a/types/hexo/tsconfig.json +++ b/types/basil.js/tsconfig.json @@ -6,14 +6,14 @@ ], "noImplicitAny": true, "noImplicitThis": true, - "strictNullChecks": true, "strictFunctionTypes": true, + "strictNullChecks": true, "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true }, "files": [ "index.d.ts", - "hexo-tests.ts" + "basil.js-tests.ts" ] } diff --git a/types/bbcode-to-react/bbcode-to-react-tests.ts b/types/bbcode-to-react/bbcode-to-react-tests.ts index e670398dbe6ba74..f784736cfc76137 100644 --- a/types/bbcode-to-react/bbcode-to-react-tests.ts +++ b/types/bbcode-to-react/bbcode-to-react-tests.ts @@ -1,4 +1,4 @@ -import parser, { Parser, Tag } from "bbcode-to-react"; +import parser, { Parser, Renderer, Tag, TagType } from "bbcode-to-react"; // $ExpectType void parser.registerTag("br", Tag); @@ -12,10 +12,10 @@ parser.toReact("[B]strong[/B]"); new (class extends Parser { testParser() { // $ExpectType { [name: string]: Tag<{ linkify: boolean; }>; } - this.tags; + this.tags as { [name: string]: Tag<{ linkify: boolean }> }; // $ExpectType Renderer<{ linkify: boolean; }> - this.renderer; + this.renderer as Renderer<{ linkify: boolean }>; // $ExpectType Tag<{ linkify: boolean; }> this.parse(""); @@ -74,9 +74,9 @@ new (class extends Parser { // @ExpectedType ReactNode this.toReact(); } - })(this.renderer); + })(this.renderer) as Tag; } -})(); +})() as Parser; new (class extends Parser<{ canEscape: boolean }> { testParser() { @@ -91,4 +91,4 @@ new (class extends Parser<{ canEscape: boolean }> { // $ExpectType { canEscape: boolean; }[] this.renderer.contexts; } -})(); +})() as Parser<{ canEscape: boolean }>; diff --git a/types/bbcode-to-react/index.d.ts b/types/bbcode-to-react/index.d.ts index a18209344e50181..bc0a6b5ad3ce76e 100644 --- a/types/bbcode-to-react/index.d.ts +++ b/types/bbcode-to-react/index.d.ts @@ -53,32 +53,6 @@ declare class Renderer { cosmeticReplace: (value: string) => string; } -/** - * An interface for class member in "Tag" - */ -interface TagType { - /** - * Tag name, with type string - */ - name: string; - /** - * The parent of a tag object, with type ReactNode - */ - parent: ReactNode; - /** - * The inner text of a tag object, with type string - */ - text: string; - /** - * A "params" object for inner processing - */ - params: object; - /** - * The children of a tag object, with type ReactNode array - */ - children: ReactNode[]; -} - /** * A class designed for handling bbcode. * The Tag class mostly is extended into another customized class, @@ -93,27 +67,27 @@ declare class Tag { * A "TagType" object (without children attribute) * for initializing the class member "params" */ - constructor(renderer: Renderer, settings?: Partial>); + constructor(renderer: Renderer, settings?: Partial>); /** * Tag name, with type string */ - protected name: TagType["name"]; + protected name: bbcodeToReact.TagType["name"]; /** * The parent of a tag object, with type ReactNode */ - protected parent: TagType["parent"]; + protected parent: bbcodeToReact.TagType["parent"]; /** * The inner text of a tag object, with type string */ - protected text: TagType["text"]; + protected text: bbcodeToReact.TagType["text"]; /** * A "params" object for inner processing */ - protected params: TagType["params"]; + protected params: bbcodeToReact.TagType["params"]; /** * The children of a tag object, with type ReactNode array */ - protected children: TagType["children"]; + protected children: bbcodeToReact.TagType["children"]; /** * Getter method of the "children" member of the Tag instance * @returns A ReactNode array representing the "children" member of the Tag instance @@ -186,10 +160,46 @@ declare class Parser { toReact(input: string): ReactNode; } +declare namespace bbcodeToReact { + /** + * An interface for class member in "Tag" + */ + interface TagType { + /** + * Tag name, with type string + */ + name: string; + /** + * The parent of a tag object, with type ReactNode + */ + parent: ReactNode; + /** + * The inner text of a tag object, with type string + */ + text: string; + /** + * A "params" object for inner processing + */ + params: object; + /** + * The children of a tag object, with type ReactNode array + */ + children: ReactNode[]; + } + + type Renderer = InstanceType>; + + type Tag = InstanceType>; + + type Parser = InstanceType>; +} + /** * A defualt parser instance to be exported in this library */ -declare const parser: Parser; +declare const bbcodeToReact: Parser & { + Parser: typeof Parser; + Tag: typeof Tag; +}; -export { Parser, Tag }; -export default parser; +export = bbcodeToReact; diff --git a/types/braces/braces-tests.ts b/types/braces/braces-tests.ts index 266309457e52df1..7b47903345e72e3 100644 --- a/types/braces/braces-tests.ts +++ b/types/braces/braces-tests.ts @@ -17,3 +17,9 @@ braces("x{\\a..e}y", { ...bracesOpts, keepEscaping: false }); // $ExpectType string[] braces("x{\\a..e}y", { ...bracesOpts, keepEscaping: true }); + +// $ExpectType string[] +braces("file's{A,B}*.md", { ...bracesOpts, keepQuotes: false }); + +// $ExpectType string[] +braces("file's{A,B}*.md", { ...bracesOpts, keepQuotes: true }); diff --git a/types/braces/index.d.ts b/types/braces/index.d.ts index 70f62f5b3b4375a..459e041e43207fe 100644 --- a/types/braces/index.d.ts +++ b/types/braces/index.d.ts @@ -83,6 +83,12 @@ declare namespace braces { * @default undefined */ keepEscaping?: boolean | undefined; + /** + * Do not strip quotes from the result. + * + * @default undefined + */ + keepQuotes?: boolean | undefined; } } interface Braces { diff --git a/types/bun/package.json b/types/bun/package.json index 121402049a9be56..242c2dabe22b6d1 100644 --- a/types/bun/package.json +++ b/types/bun/package.json @@ -1,21 +1,17 @@ { "private": true, "name": "@types/bun", - "version": "1.1.9999", + "version": "1.2.9999", "projects": [ "https://bun.sh" ], "dependencies": { - "bun-types": "1.1.37" + "bun-types": "1.2.2" }, "devDependencies": { "@types/bun": "workspace:." }, "owners": [ - { - "name": "Colin McDonnell", - "githubUsername": "colinhacks" - }, { "name": "Jarred Sumner", "githubUsername": "Jarred-Sumner" @@ -25,8 +21,8 @@ "githubUsername": "electroid" }, { - "name": "Dave Caruso", - "githubUsername": "paperdave" + "name": "Chloe Caruso", + "githubUsername": "paperclover" }, { "name": "Robobun", @@ -35,6 +31,14 @@ { "name": "Dylan Conway", "githubUsername": "dylan-conway" + }, + { + "name": "Meghan Denny", + "githubUsername": "nektro" + }, + { + "name": "Michael H", + "githubUsername": "RiskyMH" } ] } diff --git a/types/cache-manager-fs-hash/package.json b/types/cache-manager-fs-hash/package.json index d76fcc2b8c48b74..35d99a52117fb35 100644 --- a/types/cache-manager-fs-hash/package.json +++ b/types/cache-manager-fs-hash/package.json @@ -6,7 +6,7 @@ "https://github.com/rolandstarke/node-cache-manager-fs-hash#readme" ], "dependencies": { - "@types/cache-manager": "*" + "@types/cache-manager": "<4" }, "devDependencies": { "@types/cache-manager-fs-hash": "workspace:." diff --git a/types/cache-manager-ioredis/package.json b/types/cache-manager-ioredis/package.json index c88d905ada48d65..f2b98c8e05da5ee 100644 --- a/types/cache-manager-ioredis/package.json +++ b/types/cache-manager-ioredis/package.json @@ -6,7 +6,7 @@ "https://github.com/dabroek/node-cache-manager-ioredis" ], "dependencies": { - "@types/cache-manager": "*", + "@types/cache-manager": "<3", "@types/ioredis": "^4.28.10" }, "devDependencies": { diff --git a/types/cache-manager-memcached-store/package.json b/types/cache-manager-memcached-store/package.json index f7aabb99bec9190..2e85f5777e35845 100644 --- a/types/cache-manager-memcached-store/package.json +++ b/types/cache-manager-memcached-store/package.json @@ -6,7 +6,7 @@ "https://github.com/theogravity/node-cache-manager-memcached-store" ], "dependencies": { - "@types/cache-manager": "*" + "@types/cache-manager": "<4" }, "devDependencies": { "@types/cache-manager-memcached-store": "workspace:." diff --git a/types/cache-manager-redis-store/cache-manager-redis-store-tests.ts b/types/cache-manager-redis-store/cache-manager-redis-store-tests.ts deleted file mode 100644 index b8472471a156e35..000000000000000 --- a/types/cache-manager-redis-store/cache-manager-redis-store-tests.ts +++ /dev/null @@ -1,38 +0,0 @@ -import * as cacheManager from "cache-manager"; -import * as redisStore from "cache-manager-redis-store"; - -const redisCache = cacheManager.caching({ - store: redisStore, - host: "localhost", // default value - port: 6379, // default value - password: "XXXXX", - db: 0, - ttl: 600, -}); - -const clusterCache = cacheManager.caching({ - store: redisStore, - clusterConfig: { - nodes: [ - { - port: 6380, - host: "127.0.0.1", - }, - { - port: 6381, - host: "127.0.0.1", - }, - ], - options: { - maxRedirections: 16, - }, - }, - ttl: 600, -}); - -redisCache.store.getClient(); -clusterCache.store.getClient(); - -const memoryCache = cacheManager.caching({ store: "memory", max: 100, ttl: 60 }); - -cacheManager.multiCaching([redisCache, memoryCache]); diff --git a/types/cache-manager-redis-store/index.d.ts b/types/cache-manager-redis-store/index.d.ts deleted file mode 100644 index e31a34237937691..000000000000000 --- a/types/cache-manager-redis-store/index.d.ts +++ /dev/null @@ -1,26 +0,0 @@ -import { Cache, CacheOptions, Store, StoreConfig } from "cache-manager"; -import * as Redis from "redis"; - -declare const methods: CacheManagerRedisStore.RedisStoreConstructor; -export = methods; -export {}; - -declare module "cache-manager" { - function caching(IConfig: StoreConfig & CacheOptions): CacheManagerRedisStore.RedisCache; -} - -declare namespace CacheManagerRedisStore { - interface RedisCache extends Cache { - store: RedisStore; - } - - interface RedisStore extends Store { - name: "redis"; - getClient: () => Redis.RedisClient; - isCacheableValue: (value: any) => boolean; - } - - interface RedisStoreConstructor { - create: (options?: Redis.ClientOpts) => RedisStore; - } -} diff --git a/types/cache-manager-redis-store/package.json b/types/cache-manager-redis-store/package.json deleted file mode 100644 index 24d54b61702ecf1..000000000000000 --- a/types/cache-manager-redis-store/package.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "private": true, - "name": "@types/cache-manager-redis-store", - "version": "2.0.9999", - "projects": [ - "https://github.com/dabroek/node-cache-manager-redis-store" - ], - "dependencies": { - "@types/cache-manager": "*", - "@types/redis": "^2.8.0" - }, - "devDependencies": { - "@types/cache-manager-redis-store": "workspace:." - }, - "owners": [ - { - "name": "Eduardo Cancino", - "githubUsername": "ecancinoz-chwy" - } - ] -} diff --git a/types/cache-manager/.eslintrc.json b/types/cache-manager/.eslintrc.json deleted file mode 100644 index 42df4822d6e0a8f..000000000000000 --- a/types/cache-manager/.eslintrc.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "rules": { - "@definitelytyped/no-unnecessary-generics": "off", - "@typescript-eslint/no-unsafe-function-type": "off", - "@typescript-eslint/no-wrapper-object-types": "off" - } -} diff --git a/types/cache-manager/cache-manager-tests.ts b/types/cache-manager/cache-manager-tests.ts deleted file mode 100644 index 9bf698e950831e5..000000000000000 --- a/types/cache-manager/cache-manager-tests.ts +++ /dev/null @@ -1,122 +0,0 @@ -import * as cacheManager from "cache-manager"; - -// Args should all be optional -const memoryCacheWithNoArgs: cacheManager.Cache = cacheManager.caching({ - store: "memory", -}); - -const memoryCache: cacheManager.Cache = cacheManager.caching({ - store: "memory", - max: 20, - maxSize: 100, - sizeCalculation: (value: any, key: any) => JSON.stringify(value).length, - ttl: 10, /*seconds*/ -}); -const ttl = 5; - -memoryCache.set("foo", "bar", { ttl: ttl }, err => { - if (err) { - throw err; - } - - memoryCache.get("foo", (err, result) => { - // console.log(result); - - memoryCache.del("foo", err => {}); - }); -}); - -function getUser(id: number, cb: Function) { - cb(null, { id: id, name: "Bob" }); -} - -const userId = 123; -const key = "user_" + userId; -const key2 = "user_" + userId + "4"; - -// Note: ttl is optional in wrap() -memoryCache.wrap<{ id: number; name: string }>( - key, - (cb: any) => { - getUser(userId, cb); - }, - { ttl: ttl }, - (err: any, user: { id: number; name: string }) => { - // console.log(user); - - // Second time fetches user from memoryCache - memoryCache.wrap<{ id: number; name: string }>( - key, - key2, - (cb: any) => { - getUser(userId, cb); - }, - (err: any, user: { id: number; name: string }) => { - // console.log(user); - }, - ); - }, -); - -if (memoryCache.store.keys) { - memoryCache.store.keys().then(result => { - // console.log(result); - }); -} - -memoryCache.reset().then(() => { - // console.log('reset with promise'); -}); -memoryCache.reset(() => { - // console.log('reset with callback'); -}); - -async function promiseMemoryCache(cache: cacheManager.Cache) { - const KEY = "Key"; - const VALUE = "string"; - - const numberWrap: number = await cache.wrap(KEY, () => 1); - const numberWrapAsync: number = await cache.wrap(KEY, async () => 1); - - const stringWrap: string = await cache.wrap(KEY, () => VALUE); - const stringWrapAsync: string = await cache.wrap(KEY, async () => VALUE); - - const stringWrapWithCacheConfig: string = await cache.wrap(KEY, () => VALUE, { ttl: 10 }); - const stringWrapWithCacheConfigAsync: string = await cache.wrap(KEY, async () => VALUE, { ttl: 10 }); - - const setWithoutOptional = await cache.set(KEY, VALUE); - const setWitOptional = await cache.set(KEY, VALUE, { ttl: 10 }); - - const stringTypeSet: string = await cache.set(KEY, VALUE); - const stringTypeGet: string | undefined = await cache.get(KEY); - - const numberTypeSet: number = await cache.set(KEY, 1); - const numberTypeGet: number | undefined = await cache.get(KEY); - - interface Custom { - test: string; - } - - const CustomValue: Custom = { test: VALUE }; - - const customTypeSet: Custom = await cache.set(KEY, CustomValue); - const customTypeGet: Custom | undefined = await cache.get(KEY); -} - -const multiCache = cacheManager.multiCaching([memoryCache]); - -multiCache.set("foo", "bar", { ttl: ttl }, err => { - if (err) { - throw err; - } - - multiCache.get("foo", (err, result) => { - // console.log(result); - - multiCache.del("foo", err => {}); - }); -}); - -multiCache.reset(() => { - // console.log('multiCache reset'); -}); diff --git a/types/cache-manager/index.d.ts b/types/cache-manager/index.d.ts deleted file mode 100644 index ccfc24dad3cd7ee..000000000000000 --- a/types/cache-manager/index.d.ts +++ /dev/null @@ -1,112 +0,0 @@ -export interface CachingConfig { - ttl?: number | TtlFunction; -} - -export interface TtlFunction { - (result: any): number; -} - -export interface Store { - // These functions will just be bound to the Cache object if they exist so args can be anything - get(...args: any[]): Promise; - set(...args: any[]): Promise; - - mget?(...args: any[]): Promise; - mset?(...args: any[]): Promise; - del?(...args: any[]): Promise; - setex?(...args: any[]): Promise; - reset?(...args: any[]): Promise; - keys?(...args: any[]): Promise; - ttl?(...args: any[]): Promise; -} - -export interface StoreConfig extends CachingConfig { - store: - | "memory" - | "none" - | Store - | { - create(...args: any[]): Store; - }; - max?: number; - maxSize?: number; - sizeCalculation?: (value: any, key: any) => number; - - /** - * You may pass in any other arguments these will be passed on to the `create` method of your store, - * otherwise they will be ignored. - */ - [key: string]: any; -} - -export interface CacheOptions { - /** - * Promise library to replace global.Promise - */ - promiseDependency?: any; - isCacheableValue?(value: any): boolean; -} - -export type CallbackFunc = (error: any, result: T) => void; -export type WrapArgsType = - | string - | ((callback: CallbackFunc) => void) - | CachingConfig - | CallbackFunc - | (() => PromiseLike | T); - -export interface Cache { - set(key: string, value: T, options?: CachingConfig): Promise; - set(key: string, value: T, ttl: number): Promise; - set(key: string, value: T, options: CachingConfig, callback: (error: any) => void): void; - set(key: string, value: T, ttl: number, callback: (error: any) => void): void; - - // 2021-01-14: This could be updated with TypeScript 4.2 https://devblogs.microsoft.com/typescript/announcing-typescript-4-2-beta/#leading-middle-rest-elements-in-tuple-types - // Because the library accepts multiple keys as arguments but not as an array and rather as individual parameters - // of the function, the type definition had to be changed to this rather than specific ones - // actual definitions would looks like this (impossible in typescript): - // wrap(...keys: string[], work: (callback: (error: any, result: T) => void) => void, options: CachingConfig, callback: (error: any, result: T) => void): void - // wrap(...keys: string[], work: (callback: (error: any, result: T) => void) => void, callback: (error: any, result: T) => void): void - // wrap(...keys: string[], work: (callback: (error: any, result: T) => void) => void, options: CachingConfig): void - // wrap(...keys: string[], work: (callback: (error: any, result: T) => void) => void): Promise; - wrap(...args: Array>): Promise; - - get(key: string, callback: (error: any, result: T | undefined) => void): void; - get(key: string): Promise; - - del(key: string, callback: (error: any) => void): void; - del(key: string): Promise; - - reset(): Promise; - reset(cb: () => void): void; - - store: Store; -} - -export interface MultiCache { - set(key: string, value: T, options?: CachingConfig): Promise; - set(key: string, value: T, ttl: number): Promise; - set(key: string, value: T, options: CachingConfig, callback: (error: any) => void): void; - set(key: string, value: T, ttl: number, callback: (error: any) => void): void; - - // 2021-01-14: This could be updated with TypeScript 4.2 https://devblogs.microsoft.com/typescript/announcing-typescript-4-2-beta/#leading-middle-rest-elements-in-tuple-types - // Because the library accepts multiple keys as arguments but not as an array and rather as individual parameters - // of the function, the type definition had to be changed to this rather than specific ones - // actual definitions would looks like this (impossible in typescript): - // wrap(...keys: string[], work: (callback: (error: any, result: T) => void) => void, options: CachingConfig, callback: (error: any, result: T) => void): void - // wrap(...keys: string[], work: (callback: (error: any, result: T) => void) => void, callback: (error: any, result: T) => void): void - // wrap(...keys: string[], work: (callback: (error: any, result: T) => void) => void, options: CachingConfig): void - // wrap(...keys: string[], work: (callback: (error: any, result: T) => void) => void): Promise; - wrap(...args: Array>): Promise; - - get(key: string, callback: (error: any, result: T | undefined) => void): void; - get(key: string): Promise; - - del(key: string, callback: (error: any) => void): void; - del(key: string): Promise; - - reset(cb: () => void): void; -} - -export function caching(IConfig: StoreConfig & CacheOptions): Cache; -export function multiCaching(Caches: Cache[], options?: CacheOptions): MultiCache; diff --git a/types/cache-manager/package.json b/types/cache-manager/package.json deleted file mode 100644 index 1e6999b464534ba..000000000000000 --- a/types/cache-manager/package.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "private": true, - "name": "@types/cache-manager", - "version": "4.0.9999", - "projects": [ - "https://github.com/BryanDonovan/node-cache-manager" - ], - "devDependencies": { - "@types/cache-manager": "workspace:." - }, - "owners": [ - { - "name": "Dominik Einkemmer", - "githubUsername": "dominikeinkemmer" - }, - { - "name": "Eduard Marbach", - "githubUsername": "BlackDark" - }, - { - "name": "Bryan Donovan", - "githubUsername": "BryanDonovan" - } - ] -} diff --git a/types/cache-manager/tsconfig.json b/types/cache-manager/tsconfig.json deleted file mode 100644 index 717b2151284e582..000000000000000 --- a/types/cache-manager/tsconfig.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "compilerOptions": { - "module": "node16", - "lib": [ - "es6" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": true, - "strictFunctionTypes": true, - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "cache-manager-tests.ts" - ] -} diff --git a/types/canvas-confetti/canvas-confetti-tests.ts b/types/canvas-confetti/canvas-confetti-tests.ts index 87e57cd8a809ce9..2a3dc2e830d7b1f 100644 --- a/types/canvas-confetti/canvas-confetti-tests.ts +++ b/types/canvas-confetti/canvas-confetti-tests.ts @@ -2,80 +2,119 @@ import confetti = require("canvas-confetti"); confetti.Promise = null; -confetti(); - -confetti({ - particleCount: 150, -}); - -confetti({ - spread: 180, -}); +declare const matrix: DOMMatrix; +declare const bitmap: ImageBitmap; +confetti(); +confetti({}); confetti({ - particleCount: 100, - startVelocity: 30, - spread: 360, + angle: 90, + colors: ["#bada55"], + decay: 0.9, + disableForReducedMotion: true, + drift: 0, + flat: true, + gravity: 1, origin: { x: Math.random(), - // since they fall down, start a bit higher than random y: Math.random() - 0.2, }, + particleCount: 150, + scalar: 1, + shapes: [ + { + type: "path", + path: "string", + matrix, + }, + { + type: "bitmap", + bitmap, + matrix, + }, + "square", + "circle", + "star", + ], + spread: 180, + startVelocity: 30, + ticks: 200, + zIndex: 100, }); -confetti({ - particleCount: 100, - spread: 70, - drift: 1, - origin: { - y: 0.6, - }, -}); +declare const canvas: HTMLCanvasElement; -function r(min: number, max: number) { - return Math.random() * (max - min) + min; -} +let customConfetti = confetti.create(); +customConfetti = confetti.create(canvas); +customConfetti = confetti.create(canvas, {}); +customConfetti = confetti.create(canvas, { + disableForReducedMotion: true, + resize: true, + useWorker: true, +}); -confetti({ - angle: r(55, 125), - spread: r(50, 70), - particleCount: r(50, 100), +customConfetti(); +customConfetti({}); +customConfetti({ + angle: 90, + colors: ["#bada55"], + decay: 0.9, + disableForReducedMotion: true, drift: 0, + flat: true, + gravity: 1, origin: { - y: 0.6, + x: Math.random(), + y: Math.random() - 0.2, }, - shapes: ["square", "circle", "square", "star"], + particleCount: 150, + scalar: 1, + shapes: [ + { + type: "path", + path: "string", + matrix, + }, + { + type: "bitmap", + bitmap, + matrix, + }, + "square", + "circle", + "star", + ], + spread: 180, + startVelocity: 30, + ticks: 200, + zIndex: 100, }); -const canvas = document.createElement("canvas"); -const myConfetti = confetti.create(canvas); - -myConfetti(); - confetti.reset(); -myConfetti.reset(); - -myConfetti({ - particleCount: 150, -}); +customConfetti.reset(); -confetti()!.then(() => { - // ready -}); confetti()!.then(param => { param; // $ExpectType undefined }); -confetti.create(undefined, undefined); +declare const path: string; -confetti.shapeFromPath({ - path: - "M0 2.51004C1.39 1.80004 2.85 1.22004 4.35 0.760044C5.88 0.430044 7.43 0.230044 9 0.170044C10.55 0.230044 12.11 0.430044 13.63 0.760044C15.13 1.21004 16.6 1.80004 18 2.51004C18 5.17004 18 7.83004 18 10.49C16.58 9.77004 15.14 9.20004 13.64 8.74004C12.11 8.41004 10.55 8.21004 8.98 8.15004C7.42 8.21004 5.88 8.42004 4.35 8.75004C2.84 9.21004 1.39 9.79004 0 10.51C0 7.83004 0 5.17004 0 2.51004Z", -}); +// @ts-ignore - Need an argument +confetti.shapeFromPath(); +confetti.shapeFromPath(path); -confetti.shapeFromText({ text: "🎉" }); +// @ts-ignore - `pathData.path` is required +confetti.shapeFromPath({}); +confetti.shapeFromPath({ path }); +confetti.shapeFromPath({ path, matrix }); -confetti.shapeFromText({ text: "🎉", fontFamily: "Apple Color Emoji" }); +declare const text: string; +// @ts-ignore - Need an argument +confetti.shapeFromText(); +confetti.shapeFromText(text); -confetti.shapeFromText({ text: "✷", color: "hotpink", fontFamily: "Arial" }); +// @ts-ignore - `textData.text` is required +confetti.shapeFromText({}); +confetti.shapeFromText({ text }); +confetti.shapeFromText({ text, scalar: 1, color: "hotpink", fontFamily: "Arial" }); diff --git a/types/canvas-confetti/index.d.ts b/types/canvas-confetti/index.d.ts index 4590661df10d666..90a265c411f5696 100644 --- a/types/canvas-confetti/index.d.ts +++ b/types/canvas-confetti/index.d.ts @@ -63,6 +63,12 @@ declare namespace confetti { * @default 0 */ drift?: number | undefined; + /** + * Optionally turns off the tilt and wobble that three dimensional confetti would have in the real world. + * Yeah, they look a little sad, but y'all asked for them, so don't blame me. + * @default false + */ + flat?: boolean | undefined; /** * How quickly the particles are pulled down. 1 is full gravity, 0.5 is half gravity, etc., but there are no limits. * @default 1 @@ -127,6 +133,7 @@ declare namespace confetti { /** * Disables confetti entirely for users that prefer reduced motion. When set to true, use of this * confetti instance will always respect a user's request for reduced motion and disable confetti for them. + * @default false */ disableForReducedMotion?: boolean | undefined; /** @@ -144,20 +151,39 @@ declare namespace confetti { /** * This helper method lets you create a custom confetti shape using an SVG Path string. */ - function shapeFromPath({ path, matrix }: { path: string; matrix?: DOMMatrix }): Shape; + function shapeFromPath(pathData: string): Shape; + function shapeFromPath(pathData: { path: string; matrix?: DOMMatrix }): Shape; /** * This is the highly anticipated feature to render emoji confetti! Use any standard unicode emoji. Or other text. */ - function shapeFromText({ - text, - scalar, - color, - fontFamily, - }: { + function shapeFromText( + /** + * The text to be rendered as a confetti. If you can't make up your mind, I suggest "🐈". + */ + textData: string, + ): Shape; + function shapeFromText(textData: { + /** + * The text to be rendered as a confetti. If you can't make up your mind, I suggest "🐈". + */ text: string; + /** + * A scale value relative to the default size. It matches the scalar value in the confetti options. + * @default 1 + */ scalar?: number; + /** + * The color used to render the text. + * @default '#000000' + */ color?: string; + /** + * The font family name to use when rendering the text. + * The default follows [best practices for rendring the native OS emoji of the device](https://nolanlawson.com/2022/04/08/the-struggle-of-using-native-emoji-on-the-web/), falling back to sans-serif. + * If using a web font, make sure this [font is loaded](https://developer.mozilla.org/en-US/docs/Web/API/FontFace/load) before rendering your confetti. + * @default '"Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji", "EmojiOne Color", "Android Emoji", "Twemoji Mozilla", "system emoji", sans-serif' + */ fontFamily?: string; }): Shape; diff --git a/types/canvas-confetti/package.json b/types/canvas-confetti/package.json index 7264d397510ae07..56eea6332bd5a52 100644 --- a/types/canvas-confetti/package.json +++ b/types/canvas-confetti/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/canvas-confetti", - "version": "1.6.9999", + "version": "1.9.9999", "projects": [ "https://github.com/catdad/canvas-confetti#readme" ], diff --git a/types/carbon__pictograms-react/carbon__pictograms-react-tests.tsx b/types/carbon__pictograms-react/carbon__pictograms-react-tests.tsx index 11367860aa310d1..9abfadb111fac36 100644 --- a/types/carbon__pictograms-react/carbon__pictograms-react-tests.tsx +++ b/types/carbon__pictograms-react/carbon__pictograms-react-tests.tsx @@ -23,6 +23,7 @@ import { IbmCloud, IbmZ, IbmZAndLinuxoneMultiFrame, + MagicWand, MovingDolly, RedHatApplications, ShanghaiSkyline, @@ -73,3 +74,4 @@ import * as React from "react"; ; // $ExpectType Element ; // $ExpectType Element ; // $ExpectType Element +; // $ExpectType Element diff --git a/types/carbon__pictograms-react/es/index.d.ts b/types/carbon__pictograms-react/es/index.d.ts index 65c685ec2b45a2e..3a4eb2c567cd7ca 100644 --- a/types/carbon__pictograms-react/es/index.d.ts +++ b/types/carbon__pictograms-react/es/index.d.ts @@ -601,6 +601,7 @@ export { InternetOfThings } from "../"; export { Invoice } from "../"; export { IotMunich } from "../"; export { ItInfrastructureSoftware } from "../"; +export { JapanMtFuji } from "../"; export { Java } from "../"; export { Javascript } from "../"; export { Juice } from "../"; @@ -654,6 +655,7 @@ export { MachineLearning_07 } from "../"; export { MadridCathedral } from "../"; export { MadridSkyscrapers } from "../"; export { MadridStatue } from "../"; +export { MagicWand } from "../"; export { Magnify } from "../"; export { MailVerse } from "../"; export { MainframeQualitiesOfService } from "../"; @@ -849,6 +851,7 @@ export { RecycleBin } from "../"; export { RedHatApplications } from "../"; export { RedefiningFinancialServices } from "../"; export { ReducingCost } from "../"; +export { ReferenceArchitecture } from "../"; export { Refinery } from "../"; export { Refresh } from "../"; export { RelationshipDiagram } from "../"; @@ -1160,6 +1163,7 @@ export { Websphere } from "../"; export { WeddingCake } from "../"; export { Wheat } from "../"; export { Whistle } from "../"; +export { WhitePaper } from "../"; export { Wifi } from "../"; export { WindPower } from "../"; export { Windows } from "../"; diff --git a/types/carbon__pictograms-react/es/japan--mt-fuji/index.d.ts b/types/carbon__pictograms-react/es/japan--mt-fuji/index.d.ts new file mode 100644 index 000000000000000..740a7ff5fceaac3 --- /dev/null +++ b/types/carbon__pictograms-react/es/japan--mt-fuji/index.d.ts @@ -0,0 +1 @@ +export { JapanMtFuji as default } from "../../"; diff --git a/types/carbon__pictograms-react/es/magic-wand/index.d.ts b/types/carbon__pictograms-react/es/magic-wand/index.d.ts new file mode 100644 index 000000000000000..7d77ce46ed4ef08 --- /dev/null +++ b/types/carbon__pictograms-react/es/magic-wand/index.d.ts @@ -0,0 +1 @@ +export { MagicWand as default } from "../../"; diff --git a/types/carbon__pictograms-react/es/reference-architecture/index.d.ts b/types/carbon__pictograms-react/es/reference-architecture/index.d.ts new file mode 100644 index 000000000000000..0c1dc02515c62e0 --- /dev/null +++ b/types/carbon__pictograms-react/es/reference-architecture/index.d.ts @@ -0,0 +1 @@ +export { ReferenceArchitecture as default } from "../../"; diff --git a/types/carbon__pictograms-react/es/white-paper/index.d.ts b/types/carbon__pictograms-react/es/white-paper/index.d.ts new file mode 100644 index 000000000000000..445ef262b66a813 --- /dev/null +++ b/types/carbon__pictograms-react/es/white-paper/index.d.ts @@ -0,0 +1 @@ +export { WhitePaper as default } from "../../"; diff --git a/types/carbon__pictograms-react/index.d.ts b/types/carbon__pictograms-react/index.d.ts index 7c3710dcd735f8d..cd912a516a38279 100644 --- a/types/carbon__pictograms-react/index.d.ts +++ b/types/carbon__pictograms-react/index.d.ts @@ -1,4 +1,4 @@ -/** 1183 pictograms in total */ +/** 1187 pictograms in total */ export interface CarbonPictogramProps extends Omit< @@ -641,6 +641,7 @@ export const InternetOfThings: CarbonPictogramType; export const Invoice: CarbonPictogramType; export const IotMunich: CarbonPictogramType; export const ItInfrastructureSoftware: CarbonPictogramType; +export const JapanMtFuji: CarbonPictogramType; export const Java: CarbonPictogramType; export const Javascript: CarbonPictogramType; export const Juice: CarbonPictogramType; @@ -694,6 +695,7 @@ export const MachineLearning_07: CarbonPictogramType; export const MadridCathedral: CarbonPictogramType; export const MadridSkyscrapers: CarbonPictogramType; export const MadridStatue: CarbonPictogramType; +export const MagicWand: CarbonPictogramType; export const Magnify: CarbonPictogramType; export const MailVerse: CarbonPictogramType; export const MainframeQualitiesOfService: CarbonPictogramType; @@ -889,6 +891,7 @@ export const RecycleBin: CarbonPictogramType; export const RedHatApplications: CarbonPictogramType; export const RedefiningFinancialServices: CarbonPictogramType; export const ReducingCost: CarbonPictogramType; +export const ReferenceArchitecture: CarbonPictogramType; export const Refinery: CarbonPictogramType; export const Refresh: CarbonPictogramType; export const RelationshipDiagram: CarbonPictogramType; @@ -1099,6 +1102,10 @@ export const Toggle: CarbonPictogramType; export const TokyoCherryBlossom: CarbonPictogramType; export const TokyoGates: CarbonPictogramType; export const TokyoTemple: CarbonPictogramType; +/** + * @deprecated + * This icon has been replaced by `JapanMtFuji` + */ export const TokyoVolcano: CarbonPictogramType; export const ToneAnalyzer: CarbonPictogramType; export const ToolOverload: CarbonPictogramType; @@ -1204,6 +1211,7 @@ export const Websphere: CarbonPictogramType; export const WeddingCake: CarbonPictogramType; export const Wheat: CarbonPictogramType; export const Whistle: CarbonPictogramType; +export const WhitePaper: CarbonPictogramType; export const Wifi: CarbonPictogramType; export const WindPower: CarbonPictogramType; export const Windows: CarbonPictogramType; diff --git a/types/carbon__pictograms-react/lib/index.d.ts b/types/carbon__pictograms-react/lib/index.d.ts index 65c685ec2b45a2e..3a4eb2c567cd7ca 100644 --- a/types/carbon__pictograms-react/lib/index.d.ts +++ b/types/carbon__pictograms-react/lib/index.d.ts @@ -601,6 +601,7 @@ export { InternetOfThings } from "../"; export { Invoice } from "../"; export { IotMunich } from "../"; export { ItInfrastructureSoftware } from "../"; +export { JapanMtFuji } from "../"; export { Java } from "../"; export { Javascript } from "../"; export { Juice } from "../"; @@ -654,6 +655,7 @@ export { MachineLearning_07 } from "../"; export { MadridCathedral } from "../"; export { MadridSkyscrapers } from "../"; export { MadridStatue } from "../"; +export { MagicWand } from "../"; export { Magnify } from "../"; export { MailVerse } from "../"; export { MainframeQualitiesOfService } from "../"; @@ -849,6 +851,7 @@ export { RecycleBin } from "../"; export { RedHatApplications } from "../"; export { RedefiningFinancialServices } from "../"; export { ReducingCost } from "../"; +export { ReferenceArchitecture } from "../"; export { Refinery } from "../"; export { Refresh } from "../"; export { RelationshipDiagram } from "../"; @@ -1160,6 +1163,7 @@ export { Websphere } from "../"; export { WeddingCake } from "../"; export { Wheat } from "../"; export { Whistle } from "../"; +export { WhitePaper } from "../"; export { Wifi } from "../"; export { WindPower } from "../"; export { Windows } from "../"; diff --git a/types/carbon__pictograms-react/lib/japan--mt-fuji/index.d.ts b/types/carbon__pictograms-react/lib/japan--mt-fuji/index.d.ts new file mode 100644 index 000000000000000..c83c04b676197e0 --- /dev/null +++ b/types/carbon__pictograms-react/lib/japan--mt-fuji/index.d.ts @@ -0,0 +1,3 @@ +import { JapanMtFuji } from "../../"; + +export = JapanMtFuji; diff --git a/types/carbon__pictograms-react/lib/magic-wand/index.d.ts b/types/carbon__pictograms-react/lib/magic-wand/index.d.ts new file mode 100644 index 000000000000000..0087b03faa59296 --- /dev/null +++ b/types/carbon__pictograms-react/lib/magic-wand/index.d.ts @@ -0,0 +1,3 @@ +import { MagicWand } from "../../"; + +export = MagicWand; diff --git a/types/carbon__pictograms-react/lib/reference-architecture/index.d.ts b/types/carbon__pictograms-react/lib/reference-architecture/index.d.ts new file mode 100644 index 000000000000000..74febf2d426fd58 --- /dev/null +++ b/types/carbon__pictograms-react/lib/reference-architecture/index.d.ts @@ -0,0 +1,3 @@ +import { ReferenceArchitecture } from "../../"; + +export = ReferenceArchitecture; diff --git a/types/carbon__pictograms-react/lib/white-paper/index.d.ts b/types/carbon__pictograms-react/lib/white-paper/index.d.ts new file mode 100644 index 000000000000000..81669f6efae191a --- /dev/null +++ b/types/carbon__pictograms-react/lib/white-paper/index.d.ts @@ -0,0 +1,3 @@ +import { WhitePaper } from "../../"; + +export = WhitePaper; diff --git a/types/chardet/chardet-tests.ts b/types/chardet/chardet-tests.ts deleted file mode 100644 index 6b7982ff1ea40a5..000000000000000 --- a/types/chardet/chardet-tests.ts +++ /dev/null @@ -1,13 +0,0 @@ -import * as chardet from "chardet"; - -chardet.detect(new Buffer("hello there!")); -chardet.detectFile("/path/to/file", (err, encoding) => {}); -chardet.detectFileSync("/path/to/file"); - -chardet.detectFile("/path/to/file", { sampleSize: 32 }, (err, encoding) => {}); - -chardet.detectAll(new Buffer("hello there!")); -chardet.detectFileAll("/path/to/file", (err, encoding) => {}); -chardet.detectFileAllSync("/path/to/file"); - -chardet.detectFileAll("/path/to/file", { sampleSize: 32 }, (err, encoding) => {}); diff --git a/types/chardet/index.d.ts b/types/chardet/index.d.ts deleted file mode 100644 index 07b2a57d4d9819b..000000000000000 --- a/types/chardet/index.d.ts +++ /dev/null @@ -1,28 +0,0 @@ -/// - -export interface Confidence { - name: string; - confidence: number; - lang?: string | undefined; -} - -export interface Options { - returnAllMatches?: boolean | undefined; - sampleSize?: number | undefined; -} - -// As of v0.6, these fns return the highest-confidence result -export function detect(buf: Buffer, opts?: Options): string | null; - -export function detectFile(path: string, cb: (err: any, result: string | null) => void): void; -export function detectFile(path: string, opts: Options, cb: (err: any, result: string | null) => void): void; - -export function detectFileSync(path: string, opts?: Options): string | null; - -// These fns were introduced in v0.6 to return an array of confidences. -export function detectAll(buf: Buffer, opts?: Options): Confidence[] | null; - -export function detectFileAll(path: string, cb: (err: any, result: Confidence[] | null) => void): void; -export function detectFileAll(path: string, opts: Options, cb: (err: any, result: Confidence[] | null) => void): void; - -export function detectFileAllSync(path: string, opts?: Options): Confidence[] | null; diff --git a/types/chardet/package.json b/types/chardet/package.json deleted file mode 100644 index 3bae874dfe60e5e..000000000000000 --- a/types/chardet/package.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "private": true, - "name": "@types/chardet", - "version": "0.8.9999", - "projects": [ - "https://github.com/runk/node-chardet" - ], - "dependencies": { - "@types/node": "*" - }, - "devDependencies": { - "@types/chardet": "workspace:." - }, - "owners": [ - { - "name": "Hauke Oldsen", - "githubUsername": "Gebatzens" - }, - { - "name": "Sam Hinshaw", - "githubUsername": "samhinshaw" - } - ] -} diff --git a/types/chardet/tsconfig.json b/types/chardet/tsconfig.json deleted file mode 100644 index ec7bf3cf6afb806..000000000000000 --- a/types/chardet/tsconfig.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "compilerOptions": { - "module": "node16", - "lib": [ - "es6" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": true, - "strictFunctionTypes": true, - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "chardet-tests.ts" - ] -} diff --git a/types/chroma-js/chroma-js-tests.ts b/types/chroma-js/chroma-js-tests.ts index 5e2c7bde989f58d..15de95afab26b71 100644 --- a/types/chroma-js/chroma-js-tests.ts +++ b/types/chroma-js/chroma-js-tests.ts @@ -1,18 +1,15 @@ -import { Color } from "chroma-js"; -import chroma = require("chroma-js"); +import chroma, { Color, Scale } from "chroma-js"; function test_chroma() { chroma("hotpink"); chroma("#ff3399"); chroma("F39"); chroma(chroma("#ff3399")); - chroma.hex("#fff"); chroma.valid(0); chroma.valid(""); chroma.valid({}); chroma.valid(null); chroma.valid(undefined); - chroma.valid("000", "hex"); chroma(0xff3399); chroma(0xff, 0x33, 0x99); @@ -82,6 +79,10 @@ function test_chroma() { chroma(0xff3399); chroma.limits(data, "k", 5); + chroma.deltaE("#ededee", "#ededee"); + chroma.deltaE("#ededee", "#ededee", 1); + chroma.deltaE("#ededee", "#ededee", 1, 1); + chroma.deltaE("#ededee", "#ededee", 1, 1, 1); } function test_color() { @@ -130,6 +131,11 @@ function test_color() { chroma("teal").css(); chroma("teal").alpha(0.5).css(); chroma("teal").css("hsl"); + chroma("teal").css("lab"); + chroma("teal").css("lch"); + chroma("teal").css("oklab"); + chroma("teal").css("oklch"); + chroma("teal").css("rgb"); chroma("orange").rgb(); chroma("orange").hsl(); chroma("white").hsl(); @@ -238,6 +244,8 @@ function test_scale() { function test_types() { const color: chroma.Color = chroma("orange"); const scale: chroma.Scale = chroma.scale("RdYlBu"); + const scale1: Scale = scale.domain([1, 10]); + const minmax: number[] = scale.domain(); } // the following should actually, pass, but TS can't disambiguate between a parameter diff --git a/types/chroma-js/index.d.cts b/types/chroma-js/index.d.cts new file mode 100644 index 000000000000000..c66487c04451a8d --- /dev/null +++ b/types/chroma-js/index.d.cts @@ -0,0 +1,2 @@ +import chroma = require("./index"); +export = chroma; diff --git a/types/chroma-js/index.d.ts b/types/chroma-js/index.d.ts index 0d936cf7ca70043..3a74c342492fd68 100644 --- a/types/chroma-js/index.d.ts +++ b/types/chroma-js/index.d.ts @@ -2,82 +2,345 @@ * Chroma.js is a tiny library for all kinds of color conversions and color scales. */ declare namespace chroma { - interface ColorSpaces { - rgb: [number, number, number]; - rgba: [number, number, number, number]; + type W3CX11ColorName = + | "aliceblue" + | "antiquewhite" + | "aqua" + | "aquamarine" + | "azure" + | "beige" + | "bisque" + | "black" + | "blanchedalmond" + | "blue" + | "blueviolet" + | "brown" + | "burlywood" + | "cadetblue" + | "chartreuse" + | "chocolate" + | "coral" + | "cornflowerblue" + | "cornsilk" + | "crimson" + | "cyan" + | "darkblue" + | "darkcyan" + | "darkgoldenrod" + | "darkgray" + | "darkgreen" + | "darkgrey" + | "darkkhaki" + | "darkmagenta" + | "darkolivegreen" + | "darkorange" + | "darkorchid" + | "darkred" + | "darksalmon" + | "darkseagreen" + | "darkslateblue" + | "darkslategray" + | "darkslategrey" + | "darkturquoise" + | "darkviolet" + | "deeppink" + | "deepskyblue" + | "dimgray" + | "dimgrey" + | "dodgerblue" + | "firebrick" + | "floralwhite" + | "forestgreen" + | "fuchsia" + | "gainsboro" + | "ghostwhite" + | "gold" + | "goldenrod" + | "gray" + | "green" + | "greenyellow" + | "grey" + | "honeydew" + | "hotpink" + | "indianred" + | "indigo" + | "ivory" + | "khaki" + | "laserlemon" + | "lavender" + | "lavenderblush" + | "lawngreen" + | "lemonchiffon" + | "lightblue" + | "lightcoral" + | "lightcyan" + | "lightgoldenrod" + | "lightgoldenrodyellow" + | "lightgray" + | "lightgreen" + | "lightgrey" + | "lightpink" + | "lightsalmon" + | "lightseagreen" + | "lightskyblue" + | "lightslategray" + | "lightslategrey" + | "lightsteelblue" + | "lightyellow" + | "lime" + | "limegreen" + | "linen" + | "magenta" + | "maroon" + | "maroon2" + | "maroon3" + | "mediumaquamarine" + | "mediumblue" + | "mediumorchid" + | "mediumpurple" + | "mediumseagreen" + | "mediumslateblue" + | "mediumspringgreen" + | "mediumturquoise" + | "mediumvioletred" + | "midnightblue" + | "mintcream" + | "mistyrose" + | "moccasin" + | "navajowhite" + | "navy" + | "oldlace" + | "olive" + | "olivedrab" + | "orange" + | "orangered" + | "orchid" + | "palegoldenrod" + | "palegreen" + | "paleturquoise" + | "palevioletred" + | "papayawhip" + | "peachpuff" + | "peru" + | "pink" + | "plum" + | "powderblue" + | "purple" + | "purple2" + | "purple3" + | "rebeccapurple" + | "red" + | "rosybrown" + | "royalblue" + | "saddlebrown" + | "salmon" + | "sandybrown" + | "seagreen" + | "seashell" + | "sienna" + | "silver" + | "skyblue" + | "slateblue" + | "slategray" + | "slategrey" + | "snow" + | "springgreen" + | "steelblue" + | "tan" + | "teal" + | "thistle" + | "tomato" + | "turquoise" + | "violet" + | "wheat" + | "white" + | "whitesmoke" + | "yellow" + | "yellowgreen"; + + type BrewerPaletteName = + | "OrRd" + | "PuBu" + | "BuPu" + | "Oranges" + | "BuGn" + | "YlOrBr" + | "YlGn" + | "Reds" + | "RdPu" + | "Greens" + | "YlGnBu" + | "Purples" + | "GnBu" + | "Greys" + | "YlOrRd" + | "PuRd" + | "Blues" + | "PuBuGn" + | "Viridis" + | "Spectral" + | "RdYlGn" + | "RdBu" + | "PiYG" + | "PRGn" + | "RdYlBu" + | "BrBG" + | "RdGy" + | "PuOr" + | "Set2" + | "Accent" + | "Set1" + | "Set3" + | "Dark2" + | "Paired" + | "Pastel2" + | "Pastel1"; + + // eslint-disable-next-line @typescript-eslint/no-empty-interface + interface Nothing {} // used to auto-complete W3CX11ColorNames + type AnyOther = T & Nothing; + + type ChromaInput = W3CX11ColorName | AnyOther | number | { [key: string]: number } | Color; + + interface ColorFormats { + cmyk: [number, number, number, number]; + gl: [number, number, number, number]; + hcg: [number, number, number]; + hcl: [number, number, number]; + hsi: [number, number, number]; hsl: [number, number, number]; hsv: [number, number, number]; - hsi: [number, number, number]; lab: [number, number, number]; - oklab: [number, number, number]; lch: [number, number, number]; + oklab: [number, number, number]; oklch: [number, number, number]; - hcl: [number, number, number]; - cmyk: [number, number, number, number]; - gl: [number, number, number, number]; + rgb: [number, number, number]; } - type InterpolationMode = "rgb" | "hsl" | "hsv" | "hsi" | "lab" | "oklab" | "lch" | "oklch" | "hcl" | "lrgb"; + type ColorFormat = keyof ColorFormats; + + type InterpolationMode = "hcl" | "hsi" | "hsl" | "hsv" | "lab" | "lch" | "lrgb" | "oklab" | "oklch" | "rgb"; + + type WhitePoint = "D50" | "D55" | "D65" | "A" | "B" | "C" | "F2" | "F7" | "F11" | "E"; interface ChromaStatic { /** - * Creates a color from a string representation (as supported in CSS). - * Creates a color from a number representation [0; 16777215] + * Attempts to guess the format of the input color for you. + * For instance, it will recognize any named color from the W3CX11 specification. + * If there's no matching named color, chroma.js checks for a hexadecimal string. + * It ignores case, the # sign is optional, and it can recognize the shorter three + * letter format as well. So, any of these are valid hexadecimal representations: + * + * #ff3399, FF3399, #f39, etc. * - * @param color The string to convert to a color. - * @return the color object. + * In addition to hex strings, hexadecimal numbers (in fact, just any number between 0 and 16777215) + * will be recognized, too. */ - (color: string | number | Color): Color; + (color: ChromaInput): Color; /** - * Create a color in the specified color space using a, b and c as values. - * - * @param colorSpace The color space to use. Defaults to "rgb". - * @return the color object. + * Create a color in the specified color format using a, b and c as values. + * The color format defaults to "rgb". */ - (a: number, b: number, c: number, colorSpace?: keyof ColorSpaces): Color; + (a: number, b: number, c: number, format?: ColorFormat): Color; - (a: number, b: number, c: number, d: number, colorSpace?: keyof ColorSpaces): Color; + /** + * Create a color in the specified color format using a, b, c, and d as values. + * The color format defaults to "rgb". + */ + (a: number, b: number, c: number, d: number, format?: ColorFormat): Color; /** - * Create a color in the specified color space using values. - * - * @param values An array of values (e.g. [r, g, b, a?]). - * @param colorSpace The color space to use. Defaults to "rgb". - * @return the color object. + * Create a color from an array of RGB values. Each parameter must be within 0..255. */ - (values: number[], colorSpace?: keyof ColorSpaces): Color; + (rgbArray: [number, number, number]): Color; /** - * Create a color from a hex or string representation (as supported in CSS). - * - * This is an alias of chroma.css(). - * - * @param color The string to convert to a color. - * @return the color object. + * Create a color from an object with attributes corresponding to a color format. */ - hex(color: string): Color; + (colorObject: { [key: string]: number }): Color; - valid(color: any, mode?: string): boolean; + /** + * Test if a color argument can be correctly parsed as color by chroma.js + * + * @example + * ```typescript + * chroma.valid('red') // true + * chroma.valid('bread') // false + * chroma.valid('#F0000D') // true + * chroma.valid('#FOOOOD') // false + * ``` + */ + valid(color: any): boolean; - hsl(h: number, s: number, l: number, alpha?: number): Color; + hsl(hue: number, saturation: number, lightness: number, alpha?: number): Color; - hsv(h: number, s: number, v: number, alpha?: number): Color; + hsv(hue: number, saturation: number, value: number, alpha?: number): Color; + /** + * CIE Lab color space. To calculate the lightness value of a color, the CIE Lab color space uses + * a reference white point. This reference white point defines what is considered to be "white" in + * the color space. By default chroma.js is using the D65 reference point. + */ lab(lightness: number, a: number, b: number, alpha?: number): Color; - oklab(lightness: number, a: number, b: number, alpha?: number): Color; + /** + * Sets the current CIE Lab white reference point. + * Possible values: + * - D50: Represents the color temperature of daylight at 5000K. + * - D55: Represents mid-morning or mid-afternoon daylight at 5500K. + * - D65: Represents average daylight at 6500K. + * - A: Represents the color temperature of a typical incandescent light bulb at approximately 2856K. + * - B: Represents noon daylight with a color temperature of approximately 4874K. + * - C: Represents average or north sky daylight; it's a theoretical construct, not often used in practical applications. + * - F2: Represents cool white fluorescent light. + * - F7: This is a broad-band fluorescent light source with a color temperature of approximately 6500K. + * - F11: This is a narrow tri-band fluorescent light source with a color temperature of approximately 4000K. + * - E: Represents an equal energy white point, where all wavelengths in the visible spectrum are equally represented. + * + * @example + * ```typescript + * chroma('hotpink').lab() // [65.49,64.24,-10.65] + * chroma.setLabWhitePoint('F2') + * chroma('hotpink').lab() // [66.28,61.45,-8.62] + * ``` + */ + setLabWhitePoint: (whitePoint: WhitePoint) => void; + + /** + * Returns the name of the currently set CIE Lab white reference point. + * + * @example + * ```typescript + * chroma.getLabWhitePoint() // "D65" + * ``` + */ + getLabWhitePoint: () => WhitePoint; + + /** + * The range for lightness and chroma depend on the hue, but go roughly from 0..100-150. + * The range for hue is 0..360. + */ + lch(lightness: number, chroma: number, hue: number, alpha?: number): Color; + + /** + * You can use hcl instead of lch. Lightness and hue channels are switched to be more consistent with HSL. + */ + hcl(hue: number, chroma: number, lightness: number, alpha?: number): Color; - lch(l: number, c: number, h: number, alpha?: number): Color; + /** + * {@link https://bottosson.github.io/posts/oklab|Oklab color space} + */ + oklab(lightness: number, a: number, b: number, alpha?: number): Color; - oklch(l: number, c: number, h: number, alpha?: number): Color; + oklch(lightness: number, chromaticity: number, hue: number, alpha?: number): Color; /** - * Same meaning as lch(), but in different order. + * Each between 0 and 1. */ - hcl(h: number, c: number, l: number, alpha?: number): Color; + cmyk(cyan: number, magenta: number, yellow: number, black: number): Color; - rgb(r: number, g: number, b: number, alpha?: number): Color; + rgb(red: number, green: number, blue: number, alpha?: number): Color; /** * GL is a variant of RGB(A), with the only difference that the components are normalized to the range of 0..1. @@ -85,43 +348,72 @@ declare namespace chroma { gl(red: number, green: number, blue: number, alpha?: number): Color; /** - * Returns a color from the color temperature scale. - * light 2000K, bright sunlight 6000K. - * Based on Neil Bartlett's implementation. - * https://github.com/neilbartlett/color-temperature + * Returns a color from the {@link https://en.wikipedia.org/wiki/Color_temperature#Categorizing_different_lighting|color temperature} scale. + * light 2000K, bright sunlight 6000K. Based on + * {@link https://github.com/neilbartlett/color-temperature|Neil Bartlett's implementation}. + * The effective temperature range goes from 0 to about 30000 Kelvin + * + * @example + * ```typescript + * chroma.temperature(2000) // #ff8b14 candle light + * chroma.temperature(3500) // #ffc38a sunset + * chroma.temperature(6500) // #fffafe daylight + * ``` */ - temperature(t: number): Color; + temperature(K: number): Color; /** * Mixes two colors. The mix ratio is a value between 0 and 1. - * The color mixing produces different results based the color space used for interpolation. Defaults to LRGB. - * @example chroma.mix('red', 'blue', 0.25) // => #bf0040 - * @example chroma.mix('red', 'blue', 0.5, 'hsl') // => #ff00ff - */ - mix(color1: string | Color, color2: string | Color, f?: number, colorSpace?: InterpolationMode): Color; - - /** - * Alias for {@see mix}. + * The color mixing produces different results based the mode used for interpolation. Defaults to lrgb. + * @example + * ```typescript + * chroma.mix([0,0,0], 'blue') // #0000b4 + * chroma.mix('red', 'blue', 0.25) // #dd0080 + * chroma.mix('red', 'blue', 0.75) // #8000dd + * chroma.mix('red', 'blue', 0.5, 'rgb') // #800080 + * chroma.mix('red', 'blue', 0.5, 'hsl') // #ff00ff + * chroma.mix('red', 'blue', 0.5, 'lab') // #ca0088 + * chroma.mix('red', 'blue', 0.5, 'lch') // #fa0080 + * chroma.mix('red', 'blue', 0.5, 'lrgb') // #b400b4 + * ``` */ - interpolate(color1: string | Color, color2: string | Color, f?: number, colorSpace?: InterpolationMode): Color; + mix(color1: ChromaInput, color2: ChromaInput, ratio?: number, mode?: InterpolationMode): Color; /** * Similar to {@link mix}, but accepts more than two colors. Simple averaging of R,G,B components and the alpha - * channel. + * channel. mode defaults to 'lrgb'. You can also provide an array of weights to compute a weighted average of colors. + * + * @example + * ```typescript + * colors = ['#ddd', 'yellow', 'red', 'teal'] + * chroma.average(colors) // #d3b480 + * chroma.average(colors, 'rgb') // #b79757 + * chroma.average(colors, 'lab') // #d3a96a + * chroma.average(colors, 'lch') // #ef9e4e + * chroma.average(colors, 'lch', [1,1,2,1]) // #f98841 + * chroma.average(colors, 'lch', [1.5,0.5,1,2.3]) // #ae9e52 + * ``` */ - average(colors: Array, colorSpace?: InterpolationMode, weights?: number[]): Color; + average(colors: ChromaInput[], mode?: InterpolationMode, weights?: number[]): Color; /** * Blends two colors using RGB channel-wise blend functions. + * + * @example + * ```typescript + * chroma.blend('4CBBFC', 'EEEE22', 'multiply') // #47af22 + * chroma.blend('4CBBFC', 'EEEE22', 'darken') // #4cbb22 + * chroma.blend('4CBBFC', 'EEEE22', 'lighten') // #eeeefc + * ``` */ blend( - color1: string | Color, - color2: string | Color, + color1: ChromaInput, + color2: ChromaInput, blendMode: "multiply" | "darken" | "lighten" | "screen" | "overlay" | "burn" | "dodge", ): Color; /** - * Returns a random color. + * Creates a random color by generating a random hexadecimal string. */ random(): Color; @@ -129,193 +421,295 @@ declare namespace chroma { * Computes the WCAG contrast ratio between two colors. * A minimum contrast of 4.5:1 is recommended {@link https://www.w3.org/TR/WCAG20-TECHS/G18.html} * to ensure that text is still readable against a background color. + * + * @example + * ```typescript + * chroma.contrast('pink', 'hotpink') // 1.721 + * chroma.contrast('pink', 'purple') // 6.124 + * ```` */ - contrast(color1: string | Color, color2: string | Color): number; + contrast(color1: ChromaInput, color2: ChromaInput): number; /** - * Computes the eucledian distance between two colors in a given color space (default is 'lab'). - * {@link https://en.wikipedia.org/wiki/Euclidean_distance#Three_dimensions} + * Computes the {@link https://www.myndex.com/APCA|APCA contrast ratio} of a text color against its background color. + * The basic idea is that you check the contrast between the text and background color + * and then use {@link https://raw.githubusercontent.com/Myndex/apca-w3/master/images/APCAlookupByContrast.jpeg|this lookup table} to find the minimum font size you're allowed to use + * (given the font weight and purpose of the text). + * + * Read more about how to interpret and use this metric at {@link https://readtech.org/ARC|APCA Readability Criterion}. + * Please note that the APCA algorithm is still in beta and may change be subject to changes in the future. + * + * @example + * ```typescript + * chroma.contrastAPCA('hotpink', 'pink') // 23.746 + * chroma.contrastAPCA('purple', 'pink') // 62.534 + * ``` */ - distance(color1: string | Color, color2: string | Color, colorSpace?: keyof ColorSpaces): number; - - /** - * Computes color difference {@link https://en.wikipedia.org/wiki/Color_difference#CMC_l:c_.281984.29} as - * developed by the Colour Measurement Committee of the Society of Dyers and Colourists (CMC) in 1984. - * The implementation is adapted from Bruce Lindbloom. - * {@link https://web.archive.org/web/20160306044036/http://www.brucelindbloom.com/javascript/ColorDiff.js} - * The parameters L (default 1) and C (default 1) are weighting factors for lightness and chromacity. - */ - deltaE(color1: string | Color, color2: string | Color, L?: number, C?: number): number; - - /** - * chroma.brewer is an map of ColorBrewer scales that are included in chroma.js for convenience. - * chroma.scale uses the colors to construct. - */ - brewer: { - OrRd: string[]; - PuBu: string[]; - BuPu: string[]; - Oranges: string[]; - BuGn: string[]; - YlOrBr: string[]; - YlGn: string[]; - Reds: string[]; - RdPu: string[]; - Greens: string[]; - YlGnBu: string[]; - Purples: string[]; - GnBu: string[]; - Greys: string[]; - YlOrRd: string[]; - PuRd: string[]; - Blues: string[]; - PuBuGn: string[]; - Viridis: string[]; - Spectral: string[]; - RdYlGn: string[]; - RdBu: string[]; - PiYG: string[]; - PRGn: string[]; - RdYlBu: string[]; - BrBG: string[]; - RdGy: string[]; - PuOr: string[]; - Set2: string[]; - Accent: string[]; - Set1: string[]; - Set3: string[]; - Dark2: string[]; - Paired: string[]; - Pastel2: string[]; - Pastel1: string[]; - }; - - /** - * Helper function that computes class breaks based on data. - * Mode: - *
  • equidistant 'e' breaks are computed by dividing the total range of the data into n groups - * of equal size. - *
  • quantile 'q' input domain is divided by quantile ranges. - *
  • logarithmic 'l' breaks are equidistant breaks but on a logarithmic scale. - *
  • k-means 'k' breaks use the 1-dimensional - * [k-means clustering algorithm]{@link https://en.wikipedia.org/wiki/K-means_clustering} to find (roughly) n - * groups of "similar" values. Note that this k-means implementation does not guarantee to find exactly n groups. - */ - limits(data: number[], mode: "e" | "q" | "l" | "k", c: number): number[]; - - /** - * Returns a function that - * [bezier-interpolates]{@link https://www.vis4.net/blog/posts/mastering-multi-hued-color-scales/} between - * colors in Lab space. The input range of the function is [0..1]. - * You can convert it to a scale instance by calling chroma.bezier(...).scale() + contrastAPCA(text: ChromaInput, background: ChromaInput): number; + + /** + * Computes the eucledian distance between two colors in a given color format (default is 'lab'). + * {@link https://en.wikipedia.org/wiki/Euclidean_distance#Three_dimensions} + * + * @example + * ```typescript + * chroma.distance('#fff', '#ff0', 'rgb') // 255 + * chroma.distance('#fff', '#f0f', 'rgb') // 255 + * chroma.distance('#fff', '#ff0') // 96.948 + * chroma.distance('#fff', '#f0f') // 122.163 + * ``` + */ + distance(color1: ChromaInput, color2: ChromaInput, format?: ColorFormat): number; + + /** + * Computes {@link https://en.wikipedia.org/wiki/Color_difference#CIEDE2000|color difference} as developed by the + * International Commission on Illumination (CIE) in 2000. The implementation is based on the formula from + * {@link http://www.brucelindbloom.com/index.html?Eqn_DeltaE_CIE2000.html|Bruce Lindbloom}. + * Resulting values range from 0 (no difference) to 100 (maximum difference), and are a metric for how the + * human eye percieves color difference. The optional parameters Kl, Kc, and Kh may be used to adjust weightings of + * lightness, chroma, and hue. + * + * @example + * ```typescript + * chroma.deltaE('#ededee', '#ededee') // 0 + * chroma.deltaE('#ededee', '#edeeed') // 1.321 + * chroma.deltaE('#ececee', '#eceeec') // 2.602 + * chroma.deltaE('#e9e9ee', '#e9eee9') // 6.221 + * chroma.deltaE('#e4e4ee', '#e4eee4') // 11.598 + * chroma.deltaE('#e0e0ee', '#e0eee0') // 15.391 + * chroma.deltaE('#000000', '#ffffff') // 100 + * ``` + */ + deltaE(color1: ChromaInput, color2: ChromaInput, Kl?: number, Kc?: number, Kh?: number): number; + + /** + * chroma.brewer is an map of {@link http://colorbrewer2.org/|ColorBrewer palettes} that are included + * in chroma.js for convenience. Chroma.scale uses the colors to construct. Note that chroma.js only + * includes the 9-step versions of the palettes (11 steps for the diverging palettes). So, for instance, + * if you use chroma.js to construct a 5-color palette, they will be different from the "official" + * 5-color palettes in ColorBrewer (which have lower contrast). + */ + brewer: Record; + + /** + * A helper function that computes class breaks for you, based on data. + * It supports the modes: + * - e: equidistant + * - breaks are computed by dividing the total range of the data into _n_ groups of equal size. + * - q: quantile + * - the input domain is divided by quantile ranges. + * - l: logarithmic + * - breaks are equidistant breaks but on a logarithmic scale. + * - k: k-means + * - break is using the 1-dimensional {@link https://en.wikipedia.org/wiki/K-means_clustering|k-means clustering algorithm} to find (roughly) _n_ groups of "similar" values. + * Note that this k-means implementation does not guarantee to find exactly _n_ groups. + * + * @example + * ```typescript + * const data = [2.0,3.5,3.6,3.8,3.8,4.1,4.3,4.4,4.6,4.9,5.2,5.3,5.4,5.7,5.8,5.9, 6.2,6.5,6.8,7.2,8] + * chroma.limits(data, 'e', 4) // [2,3.5,5,6.5,8] + * chroma.limits(data, 'q', 4) // [2,4.1,5.2,5.9,8] + * chroma.limits(data, 'l', 4) // [2,2.83,4,5.66,8] + * chroma.limits(data, 'k', 4) // [2,8] + * ``` */ - bezier(colors: string[]): { (t: number): Color; scale(): Scale }; + limits(data: number[], mode: "e" | "q" | "l" | "k", n: number): number[]; - scale(name: string | Color): Scale; + /** + * A color scale, created with chroma.scale, is a function that maps numeric values to a color palette. + * The default scale has the domain 0..1 and goes from white to black. + * You can pass an array of colors to chroma.scale. Any color that can be read by chroma() + * will work here, too. If you pass more than two colors, they will be evenly distributed along the gradient. + */ + scale(colors?: BrewerPaletteName | ChromaInput[]): Scale; - scale(colors?: Array): Scale; + /** + * Returns a function that [bezier-interpolates]{@link https://www.vis4.net/blog/posts/mastering-multi-hued-color-scales/} + * between colors in Lab space. The input range of the function is [0..1]. + * You can convert a bezier interpolator into a chroma.scale instance. + */ + bezier(colors: string[]): { (t: number): Color; scale(): Scale }; cubehelix(): Cubehelix; - - cmyk(c: number, m: number, y: number, k: number): Color; - - css(col: string): Color; } interface Color { /** * Get and set the color opacity. + * + * @example + * ```typescript + * chroma('red').alpha(0.5) // #ff000080 + * chroma('rgba(255,0,0,0.35)').alpha() // 0.35 + * ``` */ - alpha(a: number): Color; alpha(): number; + alpha(a: number): Color; - darken(f?: number): Color; - - mix(targetColor: string | Color, f?: number, colorSpace?: keyof ColorSpaces): Color; + /** + * Decreases the lightness of the color. value defaults to 1. + * + * @example + * ```typescript + * chroma('hotpink').darken() // #c93384 + * chroma('hotpink').darken(2) // #930058 + * chroma('hotpink').darken(2.6) // #74003f + * ``` + */ + darken(value?: number): Color; - brighten(f?: number): Color; + /** + * Increases the lightness of the color. value defaults to 1. + * + * @example + * ```typescript + * chroma('hotpink').brighten() // #ff9ce6 + * chroma('hotpink').brighten(2) // #ffd1ff + * chroma('hotpink').brighten(3) // #ffffff + * ``` + */ + brighten(value?: number): Color; /** * Changes the saturation of a color by manipulating the Lch chromacity. + * + * @example + * ```typescript + * chroma('slategray').saturate() // #4b83ae + * chroma('slategray').saturate(2) // #0087cd + * chroma('slategray').saturate(3) // #008bec + * ``` */ - saturate(s?: number): Color; + saturate(value?: number): Color; /** * Similar to saturate, but the opposite direction. + * + * @example + * ```typescript + * chroma('hotpink').desaturate() // #e77dae + * chroma('hotpink').desaturate(2) // #cd8ca8 + * chroma('hotpink').desaturate(3) // #b199a3 + * ``` */ - desaturate(s?: number): Color; + desaturate(value?: number): Color; /** - * Changes a single channel and returns the result a new chroma object. - * @example - * // half Lab lightness - * chroma('orangered').set('lab.l', '*0.5') + * Mix this color with a target color. The mix ratio is a value between 0 and 1. + * This is the same as chroma.mix but with the first parameter already set. + * As such, the color format used can be adjusted. + * * @example - * // double Lch saturation - * chroma('darkseagreen').set('lch.c', '*2') + * ```typescript + * chroma('hotpink').mix('blue') // #b44add + * chroma('hotpink').mix('blue', 0.25) // #dd5bc9 + * chroma('hotpink').mix('blue', 0.75, 'lab') // #811ced + * ``` */ - set(modechan: string, v: number | string): Color; + mix(targetColor: ChromaInput, ratio?: number, format?: ColorFormat): Color; /** - * Returns a single channel value. - * Also @see set + * Produce a shade of the color. This is syntactic sugar for color.mix with a target color of black. + * + * @example + * ```typescript + * chroma('hotpink').shade(0.25) // #dd5b9c + * chroma('hotpink').shade(0.5) // #b44a7f + * chroma('hotpink').shade(0.75) // #80355a + * ``` */ - get(modechan: string): number; + shade: (ratio?: number, mode?: InterpolationMode) => Color; /** - * Relative brightness, according to the - * [WCAG]{@link http://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef} definition. Normalized to - * 0 for darkest black and 1 for lightest white. + * Produce a tint of the color. This is syntactic sugar for color.mix with a target color of white. + * + * @example + * ```typescript + * chroma('hotpink').tint(0.25) // #ff9dc9 + * chroma('hotpink').tint(0.5) // #ffc3dd + * chroma('hotpink').tint(0.75) // #ffe3ee + * ``` */ - luminance(): number; + tint: (ratio?: number, mode?: InterpolationMode) => Color; /** - * Set luminance of color. The source color will be interpolated with black or white until the correct luminance is found. - * The color space used defaults to RGB. + * Changes a single channel and returns the result a new chroma object. + * Also works with relative changes + * + * @example + * ```typescript + * chroma('skyblue').set('hsl.h', 0) // #eb8787 + * chroma('hotpink').set('lch.c', 30) // #ce8ca9 + * chroma('orangered').set('lab.l', '*0.5') // #a10000 + * chroma('darkseagreen').set('lch.c', '*2') // #63c56c */ - luminance(l: number, colorSpace?: InterpolationMode): Color; + set(channel: string, value: number | string): Color; /** - * Get color as hexadecimal string. - * - * @param mode `auto` - string will include alpha channel only if it's less than 1. - * `rgb` - string will not include alpha channel. - * `rgba` - string will include alpha channel. + * Returns a single channel value. * * @example - * chroma('orange').hex() === '#ffa500' - * chroma('orange').alpha(0.5).hex() === '#ffa50080' - * chroma('orange').alpha(0.5).hex('rgb') === '#ffa500' + * ```typescript + * chroma('orangered').get('lab.l') // 57.582 + * chroma('orangered').get('hsl.l') // 0.5 + * chroma('orangered').get('rgb.g') // 69 + * ``` */ - hex(mode?: "auto" | "rgb" | "rgba"): string; + get(channel: string): number; /** - * Returns the named color. Falls back to hexadecimal RGB string, if the color isn't present. + * Relative brightness, according to the + * [WCAG]{@link http://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef} definition. + * Normalized to 0 for darkest black and 1 for lightest white. */ - name(): string; + luminance(): number; /** - * Returns a RGB() or HSL() string representation that can be used as CSS-color definition. - * mode defaults to 'rgb' + * Set luminance of color. The source color will be interpolated with black or white until + * the correct luminance is found. The color space used defaults to RGB. */ - css(mode?: "hsl"): string; + luminance(value: number, mode?: InterpolationMode): Color; /** - * Estimate the temperature in Kelvin of any given color, though this makes the only sense for colors from the - * [temperature gradient]{@link ChromaStatic.temperature} above. + * Get color as hexadecimal string. the default mode is "auto" which means that the hex string + * will include the alpha channel if it's less than 1. If you don't want the alpha channel to be + * included you must explicitly set the mode to "rgb" + * + * @example + * ```typescript + * chroma('orange').hex() // #ffa500 + * chroma('orange').alpha(0.5).hex() // #ffa50080 + * chroma('orange').alpha(0.5).hex('rgb') // #ffa500 + * chroma('orange').alpha(0.5).hex('argb') // #80ffa500 + * ``` */ - temperature(): number; + hex(mode?: "auto" | "rgb" | "rgba" | "argb"): string; /** - * Returns the numeric representation of the hexadecimal RGB color. + * Returns the named color. Falls back to hexadecimal RGB string, if the color isn't present. * * @example - * chroma('#000000').num() === 0 - * chroma('#0000ff').num() === 255 - * chroma('#00ff00').num() === 65280 - * chroma('#ff0000').num() === 16711680 + * ```typescript + * chroma('#ffa500').name() // orange + * chroma('#ffa505').name() // #ffa505 + * ``` */ - num(): number; + name(): string; + + /** + * Returns a CSS string representation that can be used as CSS-color definition. + * mode defaults to rgb + * + * @example + * ```typescript + * chroma('teal').css() // rgb(0 128 128) + * chroma('teal').alpha(0.5).css() // rgb(0 128 128 / 0.5) + * chroma('teal').css('hsl') // hsl(180deg 100% 25.1%) + * chroma('teal').css('lab') // lab(47.99% -30.39 -8.98) + * chroma('teal').css('oklch') // oklch(54.31% 0.09 194.76deg) + * ``` + */ + css(mode?: "rgb" | "hsl" | "lab" | "lch" | "oklab" | "oklch"): string; /** * Returns an array with the red, green, and blue component, each as @@ -324,20 +718,24 @@ declare namespace chroma { * You can pass false to prevent the rounding. * * @example - * chroma('orange').rgb() === [255,165,0] - * chroma('orange').darken().rgb() === [198,118,0] - * chroma('orange').darken().rgb(false) === [198.05,118.11,0] + * ```typescript + * chroma('orange').rgb() // [255,165,0] + * chroma('orange').darken().rgb() // [198,118,0] + * chroma('orange').darken().rgb(false) // [198.05,118.11,0] + * ``` */ - rgb: (round?: boolean) => ColorSpaces["rgb"]; + rgb: (round?: boolean) => ColorFormats["rgb"]; /** * Just like color.rgb but adds the alpha channel to the returned array. * * @example - * chroma('orange').rgba() === [255,165,0,1] - * chroma('hsla(20, 100%, 40%, 0.5)').rgba() === [204,68,0,0.5] + * ```typescript + * chroma('orange').rgba() // [255,165,0,1] + * chroma('hsla(20, 100%, 40%, 0.5)').rgba() // [204,68,0,0.5] + * ``` */ - rgba: (round?: boolean) => ColorSpaces["rgba"]; + rgba: (round?: boolean) => [number, number, number, number]; /** * Returns an array with the `hue`, `saturation`, and `lightness` @@ -346,10 +744,12 @@ declare namespace chroma { * (black, white, and grays), the hue component will be NaN. * * @example - * chroma('orange').hsl() === [38.82,1,0.5,1] - * chroma('white').hsl() === [NaN,0,1,1] + * ```typescript + * chroma('orange').hsl() // [38.82,1,0.5,1] + * chroma('white').hsl() // [NaN,0,1,1] + * ``` */ - hsl: () => ColorSpaces["hsl"]; + hsl: () => ColorFormats["hsl"]; /** * Returns an array with the `hue`, `saturation`, and `value` @@ -358,10 +758,12 @@ declare namespace chroma { * colors (black, white, and grays), the hue component will be NaN. * * @example - * chroma('orange').hsv() === [38.82,1,1] - * chroma('white').hsv() === [NaN,0,1] + * ```typescript + * chroma('orange').hsv() // [38.82,1,1] + * chroma('white').hsv() // [NaN,0,1] + * ``` */ - hsv: () => ColorSpaces["hsv"]; + hsv: () => ColorFormats["hsv"]; /** * Returns an array with the `hue`, `saturation`, and `intensity` @@ -369,72 +771,115 @@ declare namespace chroma { * colors (black, white, and grays), the hue component will be NaN. * * @example - * chroma('orange').hsi() === [39.64,1,0.55] - * chroma('white').hsi() === [NaN,0,1] + * ```typescript + * chroma('orange').hsi() // [39.64,1,0.55] + * chroma('white').hsi() // [NaN,0,1] + * ``` */ - hsi: () => ColorSpaces["hsi"]; + hsi: () => ColorFormats["hsi"]; /** * Returns an array with the **L**, **a**, and **b** components. * * @example - * chroma('orange').lab() === [74.94,23.93,78.95] + * ```typescript + * chroma('orange').lab() // [74.94,23.93,78.95] + * ``` */ - lab: () => ColorSpaces["lab"]; + lab: () => ColorFormats["lab"]; + + /** + * Returns an array with the **Lightness**, **chroma**, and **hue** + * components. + * + * @example + * ```typescript + * chroma('skyblue').lch() // [79.21,25.94,235.11] + * ``` + */ + lch: () => ColorFormats["lch"]; + + /** + * Alias of lch, but with the components in reverse order. + * + * @example + * ```typescript + * chroma('skyblue').hcl() // [235.11,25.94,79.21] + * ``` + */ + hcl: () => ColorFormats["hcl"]; /** * Returns an array with the **L**, **a**, and **b** components. + * in the {@link https://bottosson.github.io/posts/oklab|OKLab} color space. * * @example - * chroma('orange').oklab() === [0.7927,0.0566,0.1614] + * ```typescript + * chroma('orange').oklab() // [0.79,0.06,0.16] + * ``` */ - oklab: () => ColorSpaces["oklab"]; + oklab: () => ColorFormats["oklab"]; /** - * Returns an array with the **Lightness**, **chroma**, and **hue** - * components. + * Returns an array with the **Lightness**, **chroma**, and **hue** components + * in the {@link https://bottosson.github.io/posts/oklab|OKLch} * * @example - * chroma('skyblue').lch() === [79.21,25.94,235.11] + * ```typescript + * chroma('skyblue').oklch() // [0.81,0.08,225.74] + * ``` */ - lch: () => ColorSpaces["lch"]; + oklch: () => ColorFormats["oklch"]; /** - * Returns an array with the **Lightness**, **chroma**, and **hue** - * components. + * Returns an array with the cyan, magenta, yellow, and key (black) + * components, each as a normalized value between 0 and 1. * * @example - * chroma('skyblue').oklch() === [0.8148,0.0819,225.8] + * ```typescript + * chroma('orange').rgba() // [255,165,0,1] + * chroma('hsla(20, 100%, 40%, 0.5)').rgba() // [204,68,0,0.5] + * ```typescript */ - oklch: () => ColorSpaces["oklch"]; + cmyk: () => ColorFormats["cmyk"]; /** - * Alias of [lch](#color-lch), but with the components in reverse - * order. + * Returns the numeric representation of the hexadecimal RGB color. * * @example - * chroma('skyblue').hcl() === [235.11,25.94,79.21] + * ```typescript + * chroma('#000000').num() // 0 + * chroma('#0000ff').num() // 255 + * chroma('#00ff00').num() // 65280 + * chroma('#ff0000').num() // 16711680 + * ``` */ - hcl: () => ColorSpaces["hcl"]; + num(): number; /** - * Just like color.rgb but adds the alpha channel to the returned - * array. + * Estimate the temperature in Kelvin of any given color, though this makes + * only sense for colors from the {@link https://en.wikipedia.org/wiki/Color_temperature#Categorizing_different_lighting|temperature gradient}. * * @example - * chroma('orange').rgba() === [255,165,0,1] - * chroma('hsla(20, 100%, 40%, 0.5)').rgba() === [204,68,0,0.5] + * ```typescript + * chroma('#ff3300').temperature() // 1000 + * chroma('#ff8a13').temperature() // 2000 + * chroma('#ffe3cd').temperature() // 4999 + * chroma('#cbdbff').temperature() // 10115 + * chroma('#b3ccff').temperature() // 15169 + * ``` */ - cmyk: () => ColorSpaces["cmyk"]; + temperature(): number; /** - * Returns an array with the cyan, magenta, yellow, and key (black) - * components, each as a normalized value between 0 and 1. + * Like RGB, but in the channel range of `[0..1]` instead of `[0..255]` * * @example - * chroma('33cc00').gl() === [0.2,0.8,0,1] + * ```typescript + * chroma('#33cc00').gl() // [0.2,0.8,0,1] + * ``` */ - gl: () => ColorSpaces["gl"]; + gl: () => ColorFormats["gl"]; /** * Test if a color has been clipped or not. @@ -444,7 +889,9 @@ declare namespace chroma { * displayable on RGB monitors (such as ultraviolet). * * @example - * chroma.hcl(50, 40, 20).clipped() === true + * ```typescript + * chroma.hcl(50, 40, 20).clipped() // true + * ``` */ clipped: () => boolean; @@ -452,16 +899,20 @@ declare namespace chroma { * The unclipped RGB components. * * @example - * chroma.hcl(50, 40, 100)._rgb._unclipped === [322.65,235.24,196.7,1] + * ```typescript + * chroma.hcl(50, 40, 100).rgb() // [255,235,197] + * chroma.hcl(50, 40, 100).clipped() // true + * chroma.hcl(50, 40, 100)._rgb._unclipped // [322.65,235.24,196.7,1] + * ``` */ - _rgb: { _unclipped: ColorSpaces["rgba"] }; + _rgb: { _unclipped: [number, number, number, number] }; } interface Scale { (c: string[]): Scale; (value: number | null | undefined): OutType; - + domain(): number[]; domain(d?: number[], n?: number, mode?: string): this; mode(mode: InterpolationMode): this; @@ -483,7 +934,7 @@ declare namespace chroma { format: undefined | null | "alpha" | "darken" | "brighten" | "saturate" | "desaturate", ): Color[]; colors(c: number | undefined, format: "luminance" | "temperature"): number[]; - colors(c: number | undefined, format: K): Array; + colors(c: number | undefined, format: K): Array; colors(c: number | undefined, format?: "hex" | "name"): string[]; /** @@ -497,7 +948,7 @@ declare namespace chroma { * Set out format for scale() call. Passing null will result in a scale which outputs colors. */ out(format: null): Scale; - out(format: K): Scale; + out(format: K): Scale; out(format: "hex"): Scale; } @@ -531,5 +982,8 @@ declare namespace chroma { declare var chroma: chroma.ChromaStatic; -export = chroma; +export type Color = chroma.Color; +export type Scale = chroma.Scale; +export type Cubehelix = chroma.Cubehelix; +export default chroma; export as namespace chroma; diff --git a/types/chroma-js/package.json b/types/chroma-js/package.json index c6a192a6eadddc2..7b2ba358d7f92d2 100644 --- a/types/chroma-js/package.json +++ b/types/chroma-js/package.json @@ -1,7 +1,8 @@ { "private": true, "name": "@types/chroma-js", - "version": "2.4.9999", + "version": "3.1.9999", + "type": "module", "projects": [ "https://github.com/gka/chroma.js" ], @@ -21,5 +22,15 @@ "name": "Charlie Zhuo", "githubUsername": "CharlieZhuo" } - ] + ], + "exports": { + ".": { + "import": "./index.d.ts", + "require": "./index.d.cts" + }, + "./light": { + "import": "./index.d.ts", + "require": "./index.d.cts" + } + } } diff --git a/types/chrome/index.d.ts b/types/chrome/index.d.ts index e1948589803f911..df05e3629afc7a3 100644 --- a/types/chrome/index.d.ts +++ b/types/chrome/index.d.ts @@ -14,69 +14,137 @@ declare namespace chrome { // Accessibility Features //////////////////// /** - * Use the chrome.accessibilityFeatures API to manage Chrome's accessibility features. This API relies on the ChromeSetting prototype of the type API for getting and setting individual accessibility features. In order to get feature states the extension must request accessibilityFeatures.read permission. For modifying feature state, the extension needs accessibilityFeatures.modify permission. Note that accessibilityFeatures.modify does not imply accessibilityFeatures.read permission. - * @since Chrome 37 - * Permissions: "accessibilityFeatures.read" - * Important: This API works only on Chrome OS. + * Use the `chrome.accessibilityFeatures` API to manage Chrome's accessibility features. This API relies on the ChromeSetting prototype of the type API for getting and setting individual accessibility features. In order to get feature states the extension must request `accessibilityFeatures.read` permission. For modifying feature state, the extension needs `accessibilityFeatures.modify` permission. Note that `accessibilityFeatures.modify` does not imply `accessibilityFeatures.read` permission. + * + * Permissions: "accessibilityFeatures.read", "accessibilityFeatures.modify" */ export namespace accessibilityFeatures { - /** **ChromeOS only.** Spoken feedback (text-to-speech). */ - export var spokenFeedback: chrome.types.ChromeSetting; - /** **ChromeOS only.** Enlarged cursor. */ - export var largeCursor: chrome.types.ChromeSetting; - /** **ChromeOS only.** Sticky modifier keys (like shift or alt). */ - export var stickyKeys: chrome.types.ChromeSetting; - /** **ChromeOS only.** High contrast rendering mode. */ - export var highContrast: chrome.types.ChromeSetting; - /** **ChromeOS only.** Full screen magnification. */ - export var screenMagnifier: chrome.types.ChromeSetting; - /** **ChromeOS only.** Auto mouse click after mouse stops moving. */ - export var autoclick: chrome.types.ChromeSetting; - /** **ChromeOS only.** Virtual on-screen keyboard. */ - export var virtualKeyboard: chrome.types.ChromeSetting; - /** - * **ChromeOS only.** - * Caret highlighting. + /** `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. */ + export const animationPolicy: chrome.types.ChromeSetting<"allowed" | "once" | "none">; + + /** + * Auto mouse click after mouse stops moving. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only + */ + export const autoclick: chrome.types.ChromeSetting; + + /** + * Caret highlighting. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only * @since Chrome 51 */ - export var caretHighlight: chrome.types.ChromeSetting; + export const caretHighlight: chrome.types.ChromeSetting; + + /** + * Cursor color. The value indicates whether the feature is enabled or not, doesn't indicate the color of it. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only + * @since Chrome 85 + */ + export const cursorColor: chrome.types.ChromeSetting; + /** - * **ChromeOS only.** - * Cursor highlighting. + * Cursor highlighting. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only * @since Chrome 51 */ - export var cursorHighlight: chrome.types.ChromeSetting; + export const cursorHighlight: chrome.types.ChromeSetting; + + /** + * Dictation. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only + * @since Chrome 90 + */ + export const dictation: chrome.types.ChromeSetting; + + /** + * Docked magnifier. The value indicates whether docked magnifier feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only + * @since Chrome 87 + */ + export const dockedMagnifier: chrome.types.ChromeSetting; + /** - * **ChromeOS only.** - * Focus highlighting. + * Focus highlighting. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only * @since Chrome 51 */ - export var focusHighlight: chrome.types.ChromeSetting; + export const focusHighlight: chrome.types.ChromeSetting; + + /** + * High contrast rendering mode. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only + */ + export const highContrast: chrome.types.ChromeSetting; + + /** + * Enlarged cursor. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only + */ + export const largeCursor: chrome.types.ChromeSetting; + + /** + * Full screen magnification. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only + */ + export const screenMagnifier: chrome.types.ChromeSetting; + /** - * **ChromeOS only.** - * Select-to-speak. + * Select-to-speak. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only * @since Chrome 51 */ - export var selectToSpeak: chrome.types.ChromeSetting; + export const selectToSpeak: chrome.types.ChromeSetting; + + /** + * Spoken feedback (text-to-speech). The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only + */ + export const spokenFeedback: chrome.types.ChromeSetting; + + /** + * Sticky modifier keys (like shift or alt). The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only + */ + export const stickyKeys: chrome.types.ChromeSetting; + /** - * **ChromeOS only.** - * Switch Access. + * Switch Access. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only * @since Chrome 51 */ - export var switchAccess: chrome.types.ChromeSetting; + export const switchAccess: chrome.types.ChromeSetting; + /** - * @since Chrome 42 + * Virtual on-screen keyboard. The value indicates whether the feature is enabled or not. + * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. + * @platform ChromeOS only */ - export var animationPolicy: chrome.types.ChromeSetting; + export const virtualKeyboard: chrome.types.ChromeSetting; } //////////////////// // Action //////////////////// /** - * Use the chrome.action API to control the extension's icon in the Google Chrome toolbar. + * Use the `chrome.action` API to control the extension's icon in the Google Chrome toolbar. + * The action icons are displayed in the browser toolbar next to the omnibox. After installation, these appear in the extensions menu (the puzzle piece icon). Users can pin your extension icon to the toolbar. + * + * Manifest: "action" * @since Chrome 88, MV3 - * Manifest: "action": {...} */ export namespace action { /** @deprecated Use BadgeColorDetails instead. */ @@ -112,8 +180,6 @@ declare namespace chrome { popup: string; } - export interface BrowserClickedEvent extends chrome.events.Event<(tab: chrome.tabs.Tab) => void> {} - export interface TabIconDetails { /** Optional. Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}' */ path?: string | { [index: number]: string } | undefined; @@ -133,11 +199,21 @@ declare namespace chrome { tabId?: number | undefined; } + /** + * The collection of user-specified settings relating to an extension's action. + * @since Chrome 91 + */ export interface UserSettings { /** Whether the extension's action icon is visible on browser windows' top-level toolbar (i.e., whether the extension has been 'pinned' by the user). */ isOnToolbar: boolean; } + /** @since Chrome 130 */ + export interface UserSettingsChange { + /** Whether the extension's action icon is visible on browser windows' top-level toolbar (i.e., whether the extension has been 'pinned' by the user). */ + isOnToolbar?: boolean; + } + /** * @since Chrome 88 * Disables the action for a tab. @@ -358,16 +434,22 @@ declare namespace chrome { export function setTitle(details: TitleDetails, callback: () => void): void; /** Fired when an action icon is clicked. This event will not fire if the action has a popup. */ - export var onClicked: BrowserClickedEvent; + export const onClicked: chrome.events.Event<(tab: chrome.tabs.Tab) => void>; + + /** + * Fired when user-specified settings relating to an extension's action change. + * @since Chrome 130 + */ + export const onUserSettingsChanged: chrome.events.Event<(change: UserSettingsChange) => void>; } //////////////////// // Alarms //////////////////// /** - * Use the chrome.alarms API to schedule code to run periodically or at a specified time in the future. - * @since Chrome 22 - * Permissions: "alarms" + * Use the `chrome.alarms` API to schedule code to run periodically or at a specified time in the future. + * + * Permissions: "alarms" */ export namespace alarms { export interface AlarmCreateInfo { @@ -491,11 +573,9 @@ declare namespace chrome { // Audio //////////////////// /** - * The chrome.audio API is provided to allow users to get information about and control the audio devices attached to the system. - * This API is currently only available in kiosk mode for ChromeOS. + * The `chrome.audio` API is provided to allow users to get information about and control the audio devices attached to the system. This API is currently only available in kiosk mode for ChromeOS. * * Permissions: "audio" - * * @platform ChromeOS only * @since Chrome 59 */ @@ -679,9 +759,9 @@ declare namespace chrome { // Bookmarks //////////////////// /** - * Use the chrome.bookmarks API to create, organize, and otherwise manipulate bookmarks. Also see Override Pages, which you can use to create a custom Bookmark Manager page. - * @since Chrome 5 - * Permissions: "bookmarks" + * Use the `chrome.bookmarks` API to create, organize, and otherwise manipulate bookmarks. Also see Override Pages, which you can use to create a custom Bookmark Manager page. + * + * Permissions: "bookmarks" */ export namespace bookmarks { /** A node (either a bookmark or a folder) in the bookmark tree. Child nodes are ordered within their parent folder. */ @@ -951,9 +1031,11 @@ declare namespace chrome { // Browser Action //////////////////// /** - * Use browser actions to put icons in the main Google Chrome toolbar, to the right of the address bar. In addition to its icon, a browser action can also have a tooltip, a badge, and a popup. - * @since Chrome 5 - * Manifest: "browser_action": {...} + * Use browser actions to put icons in the main Google Chrome toolbar, to the right of the address bar. In addition to its icon, a browser action can have a tooltip, a badge, and a popup. + * + * Manifest: "browser_action" + * + * MV2 only */ export namespace browserAction { export interface BadgeBackgroundColorDetails { @@ -1130,9 +1212,9 @@ declare namespace chrome { // Browsing Data //////////////////// /** - * Use the chrome.browsingData API to remove browsing data from a user's local profile. - * @since Chrome 19 - * Permissions: "browsingData" + * Use the `chrome.browsingData` API to remove browsing data from a user's local profile. + * + * Permissions: "browsingData" */ export namespace browsingData { export interface OriginTypes { @@ -1405,8 +1487,8 @@ declare namespace chrome { //////////////////// /** * Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the extension. - * @since Chrome 25 - * Manifest: "commands": {...} + * + * Manifest: "commands" */ export namespace commands { export interface Command { @@ -1439,9 +1521,9 @@ declare namespace chrome { // Content Settings //////////////////// /** - * Use the chrome.contentSettings API to change settings that control whether websites can use features such as cookies, JavaScript, and plugins. More generally speaking, content settings allow you to customize Chrome's behavior on a per-site basis instead of globally. - * @since Chrome 16 - * Permissions: "contentSettings" + * Use the `chrome.contentSettings` API to change settings that control whether websites can use features such as cookies, JavaScript, and plugins. More generally speaking, content settings allow you to customize Chrome's behavior on a per-site basis instead of globally. + * + * Permissions: "contentSettings" */ export namespace contentSettings { type ScopeEnum = "regular" | "incognito_session_only"; @@ -1764,9 +1846,9 @@ declare namespace chrome { // Context Menus //////////////////// /** - * Use the chrome.contextMenus API to add items to Google Chrome's context menu. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages. - * @since Chrome 6 - * Permissions: "contextMenus" + * Use the `chrome.contextMenus` API to add items to Google Chrome's context menu. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages. + * + * Permissions: "contextMenus" */ export namespace contextMenus { export interface OnClickData { @@ -1901,25 +1983,7 @@ declare namespace chrome { visible?: boolean | undefined; } - export interface UpdateProperties { - documentUrlPatterns?: string[] | undefined; - checked?: boolean | undefined; - title?: string | undefined; - contexts?: ContextType[] | undefined; - /** Optional. @since Chrome 20 */ - enabled?: boolean | undefined; - targetUrlPatterns?: string[] | undefined; - onclick?: Function | undefined; - /** Optional. Note: You cannot change an item to be a child of one of its own descendants. */ - parentId?: number | string; - type?: ContextItemType | undefined; - /** - * Optional. - * @since Chrome 62 - * Whether the item is visible in the menu. - */ - visible?: boolean | undefined; - } + export interface UpdateProperties extends Omit {} export interface MenuClickedEvent extends chrome.events.Event<(info: OnClickData, tab?: chrome.tabs.Tab) => void> @@ -1931,30 +1995,48 @@ declare namespace chrome { */ export var ACTION_MENU_TOP_LEVEL_LIMIT: number; + /** + * Removes all context menu items added by this extension. + * @since Chrome 123 + */ + export function removeAll(): Promise; /** * Removes all context menu items added by this extension. * @param callback Called when removal is complete. */ - export function removeAll(callback?: () => void): void; + export function removeAll(callback: () => void): void; /** * Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in chrome.runtime.lastError). * @param callback Called when the item has been created in the browser. If there were any problems creating the item, details will be available in chrome.runtime.lastError. * @return The ID of the newly created item. */ export function create(createProperties: CreateProperties, callback?: () => void): number | string; + /** + * Updates a previously created context menu item. + * @param id The ID of the item to update. + * @param updateProperties The properties to update. Accepts the same values as the create function. + * @since Chrome 123 + */ + export function update(id: string | number, updateProperties: UpdateProperties): Promise; /** * Updates a previously created context menu item. * @param id The ID of the item to update. * @param updateProperties The properties to update. Accepts the same values as the create function. * @param callback Called when the context menu has been updated. */ - export function update(id: string | number, updateProperties: UpdateProperties, callback?: () => void): void; + export function update(id: string | number, updateProperties: UpdateProperties, callback: () => void): void; + /** + * Removes a context menu item. + * @param menuItemId The ID of the context menu item to remove. + * @since Chrome 123 + */ + export function remove(menuItemId: string | number): Promise; /** * Removes a context menu item. * @param menuItemId The ID of the context menu item to remove. * @param callback Called when the context menu has been removed. */ - export function remove(menuItemId: string | number, callback?: () => void): void; + export function remove(menuItemId: string | number, callback: () => void): void; /** * @since Chrome 21 @@ -1967,9 +2049,11 @@ declare namespace chrome { // Cookies //////////////////// /** - * Use the chrome.cookies API to query and modify cookies, and to be notified when they change. - * @since Chrome 6 - * Permissions: "cookies", host permissions + * Use the `chrome.cookies` API to query and modify cookies, and to be notified when they change. + * + * Permissions: "cookies" + * + * Manifest: "host_permissions" */ export namespace cookies { /** A cookie's 'SameSite' state (https://tools.ietf.org/html/draft-west-first-party-cookies). 'no_restriction' corresponds to a cookie set with 'SameSite=None', 'lax' to 'SameSite=Lax', and 'strict' to 'SameSite=Strict'. 'unspecified' corresponds to a cookie set without the SameSite attribute. **/ @@ -2108,6 +2192,19 @@ declare namespace chrome { cause: string; } + /** + * Details to identify the frame. + * @since Chrome 132 + */ + export interface FrameDetails { + /** The unique identifier for the document. If the frameId and/or tabId are provided they will be validated to match the document found by provided document ID. */ + documentId?: string; + /** The unique identifier for the frame within the tab. */ + frameId?: number; + /* The unique identifier for the tab containing the frame. */ + tabId?: number; + } + export interface CookieChangedEvent extends chrome.events.Event<(changeInfo: CookieChangeInfo) => void> {} /** @@ -2115,52 +2212,72 @@ declare namespace chrome { * Parameter cookieStores: All the existing cookie stores. */ export function getAllCookieStores(callback: (cookieStores: CookieStore[]) => void): void; + /** * Lists all existing cookie stores. * @return The `getAllCookieStores` method provides its result via callback or returned as a `Promise` (MV3 only). */ export function getAllCookieStores(): Promise; + + /** + * The partition key for the frame indicated. + * Can return its result via Promise in Manifest V3 + * @since Chrome 132 + */ + export function getPartitionKey(details: FrameDetails): Promise<{ partitionKey: CookiePartitionKey }>; + export function getPartitionKey( + details: FrameDetails, + callback: (details: { partitionKey: CookiePartitionKey }) => void, + ): void; + /** * Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first. * @param details Information to filter the cookies being retrieved. * Parameter cookies: All the existing, unexpired cookies that match the given cookie info. */ export function getAll(details: GetAllDetails, callback: (cookies: Cookie[]) => void): void; + /** * Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first. * @param details Information to filter the cookies being retrieved. * @return The `getAll` method provides its result via callback or returned as a `Promise` (MV3 only). */ export function getAll(details: GetAllDetails): Promise; + /** * Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist. * @param details Details about the cookie being set. * @return The `set` method provides its result via callback or returned as a `Promise` (MV3 only). */ export function set(details: SetDetails): Promise; + /** * Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist. * @param details Details about the cookie being set. * Optional parameter cookie: Contains details about the cookie that's been set. If setting failed for any reason, this will be "null", and "chrome.runtime.lastError" will be set. */ export function set(details: SetDetails, callback: (cookie: Cookie | null) => void): void; + /** * Deletes a cookie by name. * @param details Information to identify the cookie to remove. * @return The `remove` method provides its result via callback or returned as a `Promise` (MV3 only). */ export function remove(details: CookieDetails): Promise; + /** * Deletes a cookie by name. * @param details Information to identify the cookie to remove. */ export function remove(details: CookieDetails, callback?: (details: CookieDetails) => void): void; + /** * Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned. * @param details Details to identify the cookie being retrieved. * Parameter cookie: Contains details about the cookie. This parameter is null if no such cookie was found. */ export function get(details: CookieDetails, callback: (cookie: Cookie | null) => void): void; + /** * Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned. * @param details Details to identify the cookie being retrieved. @@ -2176,9 +2293,9 @@ declare namespace chrome { // Debugger //////////////////// /** - * The chrome.debugger API serves as an alternate transport for Chrome's remote debugging protocol. Use chrome.debugger to attach to one or more tabs to instrument network interaction, debug JavaScript, mutate the DOM and CSS, etc. Use the Debuggee tabId to target tabs with sendCommand and route events by tabId from onEvent callbacks. - * @since Chrome 18 - * Permissions: "debugger" + * The `chrome.debugger` API serves as an alternate transport for Chrome's remote debugging protocol. Use `chrome.debugger` to attach to one or more tabs to instrument network interaction, debug JavaScript, mutate the DOM and CSS, and more. Use the {@link Debuggee} `tabId` to target tabs with `sendCommand` and route events by `tabId` from `onEvent` callbacks. + * + * Permissions: "debugger" */ export namespace _debugger { /** Debuggee identifier. Either tabId or extensionId must be specified */ @@ -2311,13 +2428,14 @@ declare namespace chrome { } export { _debugger as debugger }; + //////////////////// // Declarative Content //////////////////// /** - * Use the chrome.declarativeContent API to take actions depending on the content of a page, without requiring permission to read the page's content. - * @since Chrome 33 - * Permissions: "declarativeContent" + * Use the `chrome.declarativeContent` API to take actions depending on the content of a page, without requiring permission to read the page's content. + * + * Permissions: "declarativeContent" */ export namespace declarativeContent { export interface PageStateUrlDetails { @@ -2407,6 +2525,14 @@ declare namespace chrome { //////////////////// // Declarative Web Request //////////////////// + /** + * Use the `chrome.declarativeWebRequest` API to intercept, block, or modify requests in-flight. It is significantly faster than the chrome.webRequest API because you can register rules that are evaluated in the browser rather than the JavaScript engine, which reduces roundtrip latencies and allows higher efficiency. + * + * Permissions: "declarativeWebRequest" + * + * MV2 only + * @deprecated Check out the {@link declarativeNetRequest} API instead + */ export namespace declarativeWebRequest { export interface HeaderFilter { nameEquals?: string | undefined; @@ -2517,9 +2643,9 @@ declare namespace chrome { // DesktopCapture //////////////////// /** - * Desktop Capture API that can be used to capture content of screen, individual windows or tabs. - * @since Chrome 34 - * Permissions: "desktopCapture" + * The Desktop Capture API captures the content of the screen, individual windows, or individual tabs. + * + * Permissions: "desktopCapture" */ export namespace desktopCapture { /** Contains properties that describe the stream. */ @@ -2558,8 +2684,9 @@ declare namespace chrome { // Dev Tools - Inspected Window //////////////////// /** - * Use the chrome.devtools.inspectedWindow API to interact with the inspected window: obtain the tab ID for the inspected page, evaluate the code in the context of the inspected window, reload the page, or obtain the list of resources within the page. - * @since Chrome 18 + * Use the `chrome.devtools.inspectedWindow` API to interact with the inspected window: obtain the tab ID for the inspected page, evaluate the code in the context of the inspected window, reload the page, or obtain the list of resources within the page. + * + * Manifest: "devtools_page" */ export namespace devtools.inspectedWindow { /** A resource within the inspected page, such as a document, a script, or an image. */ @@ -2686,8 +2813,9 @@ declare namespace chrome { // Dev Tools - Network //////////////////// /** - * Use the chrome.devtools.network API to retrieve the information about network requests displayed by the Developer Tools in the Network panel. - * @since Chrome 18 + * Use the `chrome.devtools.network` API to retrieve the information about network requests displayed by the Developer Tools in the Network panel. + * + * Manifest: "devtools_page" */ export namespace devtools.network { /** Represents a HAR entry for a specific finished request. */ @@ -2731,8 +2859,8 @@ declare namespace chrome { // Dev Tools - Performance //////////////////// /** - * The chrome.devtools.performance API allows developers to interact with the recording features of the Performance panel in Chrome DevTools. You can use this API to get notifications when recording starts or stops. - * @since Chrome 128 + * Use the `chrome.devtools.performance` API to listen to recording status updates in the Performance panel in DevTools. + * @since Chrome 129 */ export namespace devtools.performance { export interface ProfilingStartedEvent extends chrome.events.Event<() => void> {} @@ -2749,8 +2877,9 @@ declare namespace chrome { // Dev Tools - Panels //////////////////// /** - * Use the chrome.devtools.panels API to integrate your extension into Developer Tools window UI: create your own panels, access existing panels, and add sidebars. - * @since Chrome 18 + * Use the `chrome.devtools.panels` API to integrate your extension into Developer Tools window UI: create your own panels, access existing panels, and add sidebars. + * + * Manifest: "devtools_page" */ export namespace devtools.panels { export interface PanelShownEvent extends chrome.events.Event<(window: Window) => void> {} @@ -2943,10 +3072,12 @@ declare namespace chrome { // Document Scan //////////////////// /** - * Use the chrome.documentScan API to discover and retrieve images from attached paper document scanners. + * Use the `chrome.documentScan` API to discover and retrieve images from attached document scanners. + * The Document Scan API is designed to allow apps and extensions to view the content of paper documents on an attached document scanner. + * + * Permissions: "documentScan" + * @platform ChromeOS only * @since Chrome 44 - * Permissions: "documentScan" - * Important: This API works only on Chrome OS. */ export namespace documentScan { export interface DocumentScanOptions { @@ -2975,7 +3106,7 @@ declare namespace chrome { // DOM //////////////////// /** - * Use the chrome.dom API to programmatically access shadow root in an HTMLElement. + * Use the `chrome.dom` API to access special DOM APIs for Extensions * @since Chrome 88 */ export namespace dom { @@ -2988,12 +3119,12 @@ declare namespace chrome { } //////////////////// - // Dev Tools - Downloads + // Downloads //////////////////// /** - * Use the chrome.downloads API to programmatically initiate, monitor, manipulate, and search for downloads. - * @since Chrome 31 - * Permissions: "downloads" + * Use the `chrome.downloads` API to programmatically initiate, monitor, manipulate, and search for downloads. + * + * Permissions: "downloads" */ export namespace downloads { export interface HeaderNameValuePair { @@ -3393,11 +3524,12 @@ declare namespace chrome { // Enterprise Platform Keys //////////////////// /** - * Use the chrome.enterprise.platformKeys API to generate hardware-backed keys and to install certificates for these keys. The certificates will be managed by the platform and can be used for TLS authentication, network access or by other extension through chrome.platformKeys. - * @since Chrome 37 - * Permissions: "enterprise.platformKeys" - * Important: This API works only on Chrome OS. - * Note: This API is only for extensions pre-installed by policy. + * Use the `chrome.enterprise.platformKeys` API to generate keys and install certificates for these keys. The certificates will be managed by the platform and can be used for TLS authentication, network access or by other extension through {@link chrome.platformKeys}. + * + * Permissions: "enterprise.platformKeys" + * + * Note: Only available to policy installed extensions. + * @platform ChromeOS only */ export namespace enterprise.platformKeys { export interface Token { @@ -3408,15 +3540,15 @@ declare namespace chrome { id: string; /** * Implements the WebCrypto's SubtleCrypto interface. The cryptographic operations, including key generation, are hardware-backed. - * Only non-extractable RSASSA-PKCS1-V1_5 keys with modulusLength up to 2048 and ECDSA with namedCurve P-256 can be generated. Each key can be used for signing data at most once. - * Keys generated on a specific Token cannot be used with any other Tokens, nor can they be used with window.crypto.subtle. Equally, Key objects created with window.crypto.subtle cannot be used with this interface. + * Only non-extractable keys can be generated. The supported key types are RSASSA-PKCS1-V1_5 and RSA-OAEP (on Chrome versions 134+) with `modulusLength` up to 2048 and ECDSA with `namedCurve` P-256. Each RSASSA-PKCS1-V1_5 and ECDSA key can be used for signing data at most once, unless the extension is allowlisted through the KeyPermissions policy, in which case the key can be used indefinitely. RSA-OAEP keys are supported since Chrome version 134 and can be used by extensions allowlisted through that same policy to unwrap other keys. + * Keys generated on a specific `Token` cannot be used with any other Tokens, nor can they be used with `window.crypto.subtle`. Equally, `Key` objects created with `window.crypto.subtle` cannot be used with this interface. */ subtleCrypto: SubtleCrypto; /** * Implements the WebCrypto's SubtleCrypto interface. The cryptographic operations, including key generation, are software-backed. * Protection of the keys, and thus implementation of the non-extractable property, is done in software, so the keys are less protected than hardware-backed keys. - * Only non-extractable RSASSA-PKCS1-V1_5 keys with modulusLength up to 2048 can be generated. Each key can be used for signing data at most once. - * Keys generated on a specific Token cannot be used with any other Tokens, nor can they be used with window.crypto.subtle. Equally, Key objects created with window.crypto.subtle cannot be used with this interface. + * Only non-extractable keys can be generated. The supported key types are RSASSA-PKCS1-V1_5 and RSA-OAEP (on Chrome versions 134+) with `modulusLength` up to 2048. Each RSASSA-PKCS1-V1_5 key can be used for signing data at most once, unless the extension is allowlisted through the KeyPermissions policy, in which case the key can be used indefinitely. RSA-OAEP keys are supported since Chrome version 134 and can be used by extensions allowlisted through that same policy to unwrap other keys. + * Keys generated on a specific `Token` cannot be used with any other Tokens, nor can they be used with `window.crypto.subtle`. Equally, `Key` objects created with `window.crypto.subtle` cannot be used with this interface. * @since Chrome 97 */ softwareBackedSubtleCrypto: SubtleCrypto; @@ -3469,94 +3601,101 @@ declare namespace chrome { /** * Returns the available Tokens. In a regular user's session the list will always contain the user's token with id "user". If a system-wide TPM token is available, the returned list will also contain the system-wide token with id "system". The system-wide token will be the same for all sessions on this device (device in the sense of e.g. a Chromebook). - * @param callback Invoked by getTokens with the list of available Tokens. - * Parameter tokens: The list of available tokens. + * + * Can return its result via Promise since Chrome 131. */ + export function getTokens(): Promise; export function getTokens(callback: (tokens: Token[]) => void): void; /** * Returns the list of all client certificates available from the given token. Can be used to check for the existence and expiration of client certificates that are usable for a certain authentication. * @param tokenId The id of a Token returned by getTokens. - * @param callback Called back with the list of the available certificates. - * Parameter certificates: The list of certificates, each in DER encoding of a X.509 certificate. + * + * Can return its result via Promise since Chrome 131. */ + export function getCertificates(tokenId: string): Promise; export function getCertificates(tokenId: string, callback: (certificates: ArrayBuffer[]) => void): void; /** - * Imports certificate to the given token if the certified key is already stored in this token. After a successful certification request, this function should be used to store the obtained certificate and to make it available to the operating system and browser for authentication. + * Imports `certificate` to the given token if the certified key is already stored in this token. After a successful certification request, this function should be used to store the obtained certificate and to make it available to the operating system and browser for authentication. * @param tokenId The id of a Token returned by getTokens. * @param certificate The DER encoding of a X.509 certificate. - * @param callback Called back when this operation is finished. + * + * Can return its result via Promise since Chrome 131. */ - export function importCertificate(tokenId: string, certificate: ArrayBuffer, callback?: () => void): void; + export function importCertificate(tokenId: string, certificate: ArrayBuffer): Promise; + export function importCertificate(tokenId: string, certificate: ArrayBuffer, callback: () => void): void; /** - * Removes certificate from the given token if present. Should be used to remove obsolete certificates so that they are not considered during authentication and do not clutter the certificate choice. Should be used to free storage in the certificate store. + * Removes `certificate` from the given token if present. Should be used to remove obsolete certificates so that they are not considered during authentication and do not clutter the certificate choice. Should be used to free storage in the certificate store. * @param tokenId The id of a Token returned by getTokens. * @param certificate The DER encoding of a X.509 certificate. - * @param callback Called back when this operation is finished. + * + * Can return its result via Promise since Chrome 131. */ - export function removeCertificate(tokenId: string, certificate: ArrayBuffer, callback?: () => void): void; + export function removeCertificate(tokenId: string, certificate: ArrayBuffer): Promise; + export function removeCertificate(tokenId: string, certificate: ArrayBuffer, callback: () => void): void; /** - * Challenges a hardware-backed Enterprise Machine Key and emits the response as part of a remote attestation protocol. Only useful on Chrome OS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: + * Similar to `challengeMachineKey` and `challengeUserKey`, but allows specifying the algorithm of a registered key. Challenges a hardware-backed Enterprise Machine Key and emits the response as part of a remote attestation protocol. Only useful on ChromeOS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. * - * * The current device is a legitimate Chrome OS device. - * * The current device is managed by the domain specified during verification. - * * The current signed-in user is managed by the domain specified during verification. - * * The current device state complies with enterprise device policy. For example, a policy may specify that the device must not be in developer mode. - * * Any device identity emitted by the verification is tightly bound to the hardware of the current device. + * A successful verification by the Verified Access Web API is a strong signal that the current device is a legitimate ChromeOS device, the current device is managed by the domain specified during verification, the current signed-in user is managed by the domain specified during verification, and the current device state complies with enterprise device policy. For example, a policy may specify that the device must not be in developer mode. Any device identity emitted by the verification is tightly bound to the hardware of the current device. If `user` Scope is specified, the identity is also tightly bound to the current signed-in user. * - * This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise device policy. The Enterprise Machine Key does not reside in the "system" token and is not accessible by any other API. - * @param options Object containing the fields defined in ChallengeKeyOptions. - * @param callback Called back with the challenge response. + * This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise device policy. The challenged key does not reside in the `system` or `user` token and is not accessible by any other API. + * + * @param options Object containing the fields defined in {@link ChallengeKeyOptions}. + * + * Can return its result via Promise since Chrome 131. * @since Chrome 110 */ + export function challengeKey(options: ChallengeKeyOptions): Promise; export function challengeKey(options: ChallengeKeyOptions, callback: (response: ArrayBuffer) => void): void; /** - * @deprecated Deprecated since Chrome 110, use enterprise.platformKeys.challengeKey instead. + * @deprecated Deprecated since Chrome 110, use {@link challengeKey} instead. * * Challenges a hardware-backed Enterprise Machine Key and emits the response as part of a remote attestation protocol. Only useful on Chrome OS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: * - * * The current device is a legitimate Chrome OS device. + * * The current device is a legitimate ChromeOS device. * * The current device is managed by the domain specified during verification. * * The current signed-in user is managed by the domain specified during verification. * * The current device state complies with enterprise device policy. For example, a policy may specify that the device must not be in developer mode. * * Any device identity emitted by the verification is tightly bound to the hardware of the current device. * - * This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise device policy. The Enterprise Machine Key does not reside in the "system" token and is not accessible by any other API. + * This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise device policy. The Enterprise Machine Key does not reside in the `system` token and is not accessible by any other API. * @param challenge A challenge as emitted by the Verified Access Web API. - * @param registerKey If set, the current Enterprise Machine Key is registered with the "system" token and relinquishes the Enterprise Machine Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise Machine Key. Since Chrome 59. - * @param callback Called back with the challenge response. + * @param registerKey If set, the current Enterprise Machine Key is registered with the `system` token and relinquishes the Enterprise Machine Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise Machine Key. Since Chrome 59. + * + * Can return its result via Promise since Chrome 131. * @since Chrome 50 */ - + export function challengeMachineKey(challenge: ArrayBuffer): Promise; + export function challengeMachineKey(challenge: ArrayBuffer, registerKey: boolean): Promise; + export function challengeMachineKey(challenge: ArrayBuffer, callback: (response: ArrayBuffer) => void): void; export function challengeMachineKey( challenge: ArrayBuffer, registerKey: boolean, callback: (response: ArrayBuffer) => void, ): void; - export function challengeMachineKey(challenge: ArrayBuffer, callback: (response: ArrayBuffer) => void): void; /** - * @deprecated Deprecated since Chrome 110, use enterprise.platformKeys.challengeKey instead. + * @deprecated Deprecated since Chrome 110, use {@link challengeKey} instead. * - * Challenges a hardware-backed Enterprise User Key and emits the response as part of a remote attestation protocol. Only useful on Chrome OS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: + * Challenges a hardware-backed Enterprise User Key and emits the response as part of a remote attestation protocol. Only useful on ChromeOS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: * - * * The current device is a legitimate Chrome OS device. + * * The current device is a legitimate ChromeOS device. * * The current device is managed by the domain specified during verification. * * The current signed-in user is managed by the domain specified during verification. * * The current device state complies with enterprise user policy. For example, a policy may specify that the device must not be in developer mode. * * The public key emitted by the verification is tightly bound to the hardware of the current device and to the current signed-in user. * - * This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise user policy. The Enterprise User Key does not reside in the "user" token and is not accessible by any other API. + * This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise user policy. The Enterprise User Key does not reside in the `user` token and is not accessible by any other API. * @param challenge A challenge as emitted by the Verified Access Web API. - * @param registerKey If set, the current Enterprise User Key is registered with the "user" token and relinquishes the Enterprise User Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise User Key. + * @param registerKey If set, the current Enterprise User Key is registered with the `user` token and relinquishes the Enterprise User Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise User Key. * @param callback Called back with the challenge response. * @since Chrome 50 */ - + export function challengeUserKey(challenge: ArrayBuffer, registerKey: boolean): Promise; export function challengeUserKey( challenge: ArrayBuffer, registerKey: boolean, @@ -3568,11 +3707,13 @@ declare namespace chrome { // Enterprise Device Attributes //////////////////// /** - * Use the chrome.enterprise.deviceAttributes API to read device attributes. - * Permissions: "enterprise.deviceAttributes" + * Use the `chrome.enterprise.deviceAttributes` API to read device attributes. + * + * Permissions: "enterprise.deviceAttributes" + * + * Note: Only available to policy installed extensions. + * @platform ChromeOS only * @since Chrome 46 - * Important: This API works only on Chrome OS. - * Note: This API is only for extensions pre-installed by policy. */ export namespace enterprise.deviceAttributes { /** @@ -3621,12 +3762,11 @@ declare namespace chrome { // Enterprise Hardware Platform //////////////////// /** - * Use the chrome.enterprise.hardwarePlatform API to get the manufacturer and model of the hardware platform where the browser runs. + * Use the `chrome.enterprise.hardwarePlatform` API to get the manufacturer and model of the hardware platform where the browser runs. * * Permissions: "enterprise.hardwarePlatform" * - * Note: This API is only for extensions pre-installed by policy. - * @platform ChromeOS only + * Note: Only available to policy installed extensions. * @since Chrome 71 */ export namespace enterprise.hardwarePlatform { @@ -3647,8 +3787,12 @@ declare namespace chrome { // Enterprise Networking Attributes //////////////////// /** - * Use the chrome.enterprise.networkingAttributes API to read information about your current network. Note: This API is only available to extensions force-installed by enterprise policy. - * Important: This API works only on Chrome OS. + * Use the `chrome.enterprise.networkingAttributes` API to read information about your current network. Note: This API is only available to extensions force-installed by enterprise policy. + * + * Permissions: "enterprise.networkingAttributes" + * + * Note: Only available to policy installed extensions. + * @platform ChromeOS only * @since Chrome 85 */ export namespace enterprise.networkingAttributes { @@ -3672,8 +3816,7 @@ declare namespace chrome { // Events //////////////////// /** - * The chrome.events namespace contains common types used by APIs dispatching events to notify you when something interesting happens. - * @since Chrome 21 + * The `chrome.events` namespace contains common types used by APIs dispatching events to notify you when something interesting happens. */ export namespace events { /** Filters URLs for various criteria. See event filtering. All criteria are case sensitive. */ @@ -3728,8 +3871,12 @@ declare namespace chrome { originAndPathMatches?: string | undefined; } - export interface BaseEvent { - addListener(callback: T, filter?: webRequest.RequestFilter): void; + export interface Event { + /** + * Registers an event listener callback to an event. + * @param callback Called when an event occurs. The parameters of this function depend on the type of event. + */ + addListener(callback: T): void; /** * Returns currently registered rules. * @param callback Called with registered rules. @@ -3787,18 +3934,6 @@ declare namespace chrome { hasListeners(): boolean; } - /** An object which allows the addition and removal of listeners for a Chrome event. */ - interface Event extends BaseEvent { - /** - * Registers an event listener callback to an event. - * @param callback Called when an event occurs. The parameters of this function depend on the type of event. - */ - addListener(callback: T): void; - } - export interface EventWithRequiredFilterInAddListener extends BaseEvent { - addListener(callback: T, filter: webRequest.RequestFilter): void; - } - /** Description of a declarative rule for handling events. */ export interface Rule { /** Optional. Optional priority of this rule. Defaults to 100. */ @@ -3822,8 +3957,7 @@ declare namespace chrome { // Extension //////////////////// /** - * The chrome.extension API has utilities that can be used by any extension page. It includes support for exchanging messages between an extension and its content scripts or between extensions, as described in detail in Message Passing. - * @since Chrome 5 + * The `chrome.extension` API has utilities that can be used by any extension page. It includes support for exchanging messages between an extension and its content scripts or between extensions, as described in detail in Message Passing. */ export namespace extension { export interface FetchProperties { @@ -3943,10 +4077,10 @@ declare namespace chrome { // File Browser Handler //////////////////// /** - * Use the chrome.fileBrowserHandler API to extend the Chrome OS file browser. For example, you can use this API to enable users to upload files to your website. - * @since Chrome 12 - * Permissions: "fileBrowserHandler" - * Important: This API works only on Chrome OS. + * Use the `chrome.fileBrowserHandler` API to extend the Chrome OS file browser. For example, you can use this API to enable users to upload files to your website. + * + * Permissions: "fileBrowserHandler" + * @platform ChromeOS only */ export namespace fileBrowserHandler { export interface SelectionParams { @@ -3996,10 +4130,10 @@ declare namespace chrome { // File System Provider //////////////////// /** - * Use the chrome.fileSystemProvider API to create file systems, that can be accessible from the file manager on Chrome OS. - * @since Chrome 40 - * Permissions: "fileSystemProvider" - * Important: This API works only on Chrome OS. + * Use the `chrome.fileSystemProvider` API to create file systems, that can be accessible from the file manager on Chrome OS. + * + * Permissions: "fileSystemProvider" + * @platform ChromeOS only */ export namespace fileSystemProvider { export interface OpenedFileInfo { @@ -4528,9 +4662,9 @@ declare namespace chrome { // Font Settings //////////////////// /** - * Use the chrome.fontSettings API to manage Chrome's font settings. - * @since Chrome 22 - * Permissions: "fontSettings" + * Use the `chrome.fontSettings` API to manage Chrome's font settings. + * + * Permissions: "fontSettings" */ export namespace fontSettings { /** Represents a font name. */ @@ -4753,9 +4887,9 @@ declare namespace chrome { // Google Cloud Messaging //////////////////// /** - * Use chrome.gcm to enable apps and extensions to send and receive messages through the Google Cloud Messaging Service. - * @since Chrome 35 - * Permissions: "gcm" + * Use `chrome.gcm` to enable apps and extensions to send and receive messages through Firebase Cloud Messaging (FCM). + * + * Permissions: "gcm" */ export namespace gcm { export interface OutgoingMessage { @@ -4835,9 +4969,9 @@ declare namespace chrome { // History //////////////////// /** - * Use the chrome.history API to interact with the browser's record of visited pages. You can add, remove, and query for URLs in the browser's history. To override the history page with your own version, see Override Pages. - * @since Chrome 5 - * Permissions: "history" + * Use the `chrome.history` API to interact with the browser's record of visited pages. You can add, remove, and query for URLs in the browser's history. To override the history page with your own version, see Override Pages. + * + * Permissions: "history" */ export namespace history { /** An object encapsulating one visit to a URL. */ @@ -4969,8 +5103,9 @@ declare namespace chrome { // i18n //////////////////// /** - * Use the chrome.i18n infrastructure to implement internationalization across your whole app or extension. - * @since Chrome 5 + * Use the `chrome.i18n` infrastructure to implement internationalization across your whole app or extension. + * + * Manifest: "default_locale" */ export namespace i18n { /** Holds detected ISO language code and its percentage in the input string */ @@ -5032,9 +5167,9 @@ declare namespace chrome { // Identity //////////////////// /** - * Use the chrome.identity API to get OAuth2 access tokens. - * Permissions: "identity" - * @since Chrome 29 + * Use the `chrome.identity` API to get OAuth2 access tokens. + * + * Permissions: "identity" */ export namespace identity { /** @since Chrome 32 */ @@ -5207,9 +5342,9 @@ declare namespace chrome { // Idle //////////////////// /** - * Use the chrome.idle API to detect when the machine's idle state changes. - * Permissions: "idle" - * @since Chrome 6 + * Use the `chrome.idle` API to detect when the machine's idle state changes. + * + * Permissions: "idle" */ export namespace idle { export type IdleState = "active" | "idle" | "locked"; @@ -5250,9 +5385,10 @@ declare namespace chrome { // Input - IME //////////////////// /** - * Use the chrome.input.ime API to implement a custom IME for Chrome OS. This allows your extension to handle keystrokes, set the composition, and manage the candidate window. - * Permissions: "input" - * @since Chrome 21 + * Use the `chrome.input.ime` API to implement a custom IME for Chrome OS. This allows your extension to handle keystrokes, set the composition, and manage the candidate window. + * + * Permissions: "input" + * @platform ChromeOS only */ export namespace input.ime { /** See http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent */ @@ -5730,8 +5866,12 @@ declare namespace chrome { export var onReset: InputResetEvent; } + //////////////////// + // Instance ID + //////////////////// /** - * Use chrome.instanceID to access the Instance ID service. + * Use `chrome.instanceID` to access the Instance ID service. + * * Permissions: "gcm" * @since Chrome 44 */ @@ -5814,10 +5954,11 @@ declare namespace chrome { // LoginState //////////////////// /** - * Use the chrome.loginState API to read and monitor the login state. + * Use the `chrome.loginState` API to read and monitor the login state. + * * Permissions: "loginState" + * @platform ChromeOS only * @since Chrome 78 - * Important: This API works only on Chrome OS. */ export namespace loginState { export interface SessionStateChangedEvent extends chrome.events.Event<(sessionState: SessionState) => void> {} @@ -5842,9 +5983,9 @@ declare namespace chrome { // Management //////////////////// /** - * The chrome.management API provides ways to manage the list of extensions/apps that are installed and running. It is particularly useful for extensions that override the built-in New Tab page. - * Permissions: "management" - * @since Chrome 8 + * The `chrome.management` API provides ways to manage installed apps and extensions. + * + * Permissions: "management" */ export namespace management { /** Information about an installed extension, app, or theme. */ @@ -6162,7 +6303,7 @@ declare namespace chrome { } //////////////////// - // Notifications + // Networking //////////////////// /** * Use the networking.config API to authenticate to captive portals. @@ -6212,12 +6353,11 @@ declare namespace chrome { //////////////////// // Notifications - // https://developer.chrome.com/extensions/notifications //////////////////// /** - * Use the chrome.notifications API to create rich notifications using templates and show these notifications to users in the system tray. - * Permissions: "notifications" - * @since Chrome 28 + * Use the `chrome.notifications` API to create rich notifications using templates and show these notifications to users in the system tray. + * + * Permissions: "notifications" */ export namespace notifications { export type TemplateType = "basic" | "image" | "list" | "progress"; @@ -6401,9 +6541,10 @@ declare namespace chrome { // Offscreen //////////////////// /** - * Use the offscreen API to create and manage offscreen documents. - * @since Chrome 109, MV3 + * Use the `offscreen` API to create and manage offscreen documents. + * * Permissions: "offscreen" + * @since Chrome 109, MV3 */ export namespace offscreen { /** The reason(s) the extension is creating the offscreen document. */ @@ -6491,8 +6632,8 @@ declare namespace chrome { //////////////////// /** * The omnibox API allows you to register a keyword with Google Chrome's address bar, which is also known as the omnibox. - * Manifest: "omnibox": {...} - * @since Chrome 9 + * + * Manifest: "omnibox" */ export namespace omnibox { /** A suggest result. */ @@ -6555,9 +6696,11 @@ declare namespace chrome { // Page Action //////////////////// /** - * Use the chrome.pageAction API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages. - * Manifest: "page_action": {...} - * @since Chrome 5 + * Use the `chrome.pageAction` API to put icons in the main Google Chrome toolbar, to the right of the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages. Page actions appear grayed out when inactive. + * + * Manifest: "page_action" + * + * MV2 only */ export namespace pageAction { export interface PageActionClickedEvent extends chrome.events.Event<(tab: chrome.tabs.Tab) => void> {} @@ -6646,9 +6789,9 @@ declare namespace chrome { // Page Capture //////////////////// /** - * Use the chrome.pageCapture API to save a tab as MHTML. - * Permissions: "pageCapture" - * @since Chrome 18 + * Use the `chrome.pageCapture` API to save a tab as MHTML. + * + * Permissions: "pageCapture" */ export namespace pageCapture { export interface SaveDetails { @@ -6673,86 +6816,63 @@ declare namespace chrome { // Permissions //////////////////// /** - * Use the chrome.permissions API to request declared optional permissions at run time rather than install time, so users understand why the permissions are needed and grant only those that are necessary. - * @since Chrome 16 + * Use the `chrome.permissions` API to request declared optional permissions at run time rather than install time, so users understand why the permissions are needed and grant only those that are necessary. */ export namespace permissions { export interface Permissions { - /** - * Optional. - * List of named permissions (does not include hosts or origins). Anything listed here must appear in the optional_permissions list in the manifest. - */ - permissions?: string[] | undefined; - /** - * Optional. - * List of origin permissions. Anything listed here must be a subset of a host that appears in the optional host permission list in the manifest (optional_permissions in MV2, optional_host_permissions in MV3). For example, if http://*.example.com/ or http://* appears in the optional permissions, you can request an origin of http://help.example.com/. Any path is ignored. - */ - origins?: string[] | undefined; - } - - export interface PermissionsRemovedEvent { - addListener( - callback: (/** The permissions that have been removed*/ permissions: Permissions) => void, - ): void; - } - - export interface PermissionsAddedEvent { - addListener(callback: (/** The newly-acquired permissions*/ permissions: Permissions) => void): void; + /** The list of host permissions, including those specified in the `optional_permissions` or `permissions` keys in the manifest, and those associated with [Content Scripts](https://developer.chrome.com/docs/extensions/develop/concepts/content-scripts). */ + origins?: string[]; + /** List of named permissions (does not include hosts or origins). */ + permissions?: chrome.runtime.ManifestPermissions[]; } /** * Checks if the extension has the specified permissions. - * @return A Promise that resolves with boolean: True if the extension has the specified permissions. + * Can return its result via Promise in Manifest V3 or later since Chrome 96. */ export function contains(permissions: Permissions): Promise; - /** - * Checks if the extension has the specified permissions. - * Parameter result: True if the extension has the specified permissions. - */ export function contains(permissions: Permissions, callback: (result: boolean) => void): void; + /** * Gets the extension's current set of permissions. - * @return A Promise that resolves with Permissions object describing the extension's active permissions. + * Can return its result via Promise in Manifest V3 or later since Chrome 96. */ export function getAll(): Promise; - /** - * Gets the extension's current set of permissions. - */ export function getAll(callback: (permissions: Permissions) => void): void; + /** - * Requests access to the specified permissions. These permissions must be defined in the optional_permissions or optional_host_permissions (MV3 only) fields of the manifest. If there are any problems requesting the permissions, runtime.lastError will be set. - * @return A Promise that resolves with boolean: True if the user granted the specified permissions. + * Requests access to the specified permissions, displaying a prompt to the user if necessary. + * These permissions must either be defined in the optional_permissions field of the manifest or be required permissions that were withheld by the user. + * Paths on origin patterns will be ignored. + * You can request subsets of optional origin permissions; for example, if you specify `*://*\/*` in the `optional_permissions` section of the manifest, you can request `http://example.com/`. + * If there are any problems requesting the permissions, {@link runtime.lastError} will be set. + * Can return its result via Promise in Manifest V3 or later since Chrome 96. */ export function request(permissions: Permissions): Promise; + export function request(permissions: Permissions, callback: (granted: boolean) => void): void; + /** - * Requests access to the specified permissions. These permissions must be defined in the optional_permissions or optional_host_permissions (MV3 only) fields of the manifest. If there are any problems requesting the permissions, runtime.lastError will be set. - * Parameter granted: True if the user granted the specified permissions. - */ - export function request(permissions: Permissions, callback?: (granted: boolean) => void): void; - /** - * Removes access to the specified permissions. If there are any problems removing the permissions, runtime.lastError will be set. - * @return A Promise that resolves with boolean: True if the permissions were removed. + * Removes access to the specified permissions. If there are any problems removing the permissions, {@link runtime.lastError} will be set. + * Can return its result via Promise in Manifest V3 or later since Chrome 96. */ export function remove(permissions: Permissions): Promise; - /** - * Removes access to the specified permissions. If there are any problems removing the permissions, runtime.lastError will be set. - * Parameter removed: True if the permissions were removed. - */ - export function remove(permissions: Permissions, callback?: (removed: boolean) => void): void; + export function remove(permissions: Permissions, callback: (removed: boolean) => void): void; /** Fired when access to permissions has been removed from the extension. */ - export var onRemoved: PermissionsRemovedEvent; + export const onRemoved: chrome.events.Event<(permissions: Permissions) => void>; + /** Fired when the extension acquires new permissions. */ - export var onAdded: PermissionsAddedEvent; + export const onAdded: chrome.events.Event<(permissions: Permissions) => void>; } //////////////////// // Platform Keys //////////////////// /** - * Use the chrome.platformKeys API to access client certificates managed by the platform. If the user or policy grants the permission, an extension can use such a certficate in its custom authentication protocol. E.g. this allows usage of platform managed certificates in third party VPNs (see chrome.vpnProvider). - * Permissions: "platformKeys" - * Important: This API works only on Chrome OS. + * Use the `chrome.platformKeys` API to access client certificates managed by the platform. If the user or policy grants the permission, an extension can use such a certficate in its custom authentication protocol. E.g. this allows usage of platform managed certificates in third party VPNs (see chrome.vpnProvider). + * + * Permissions: "platformKeys" + * @platform ChromeOS only * @since Chrome 45 */ export namespace platformKeys { @@ -6848,9 +6968,9 @@ declare namespace chrome { // Power //////////////////// /** - * Use the chrome.power API to override the system's power management features. + * Use the `chrome.power` API to override the system's power management features. + * * Permissions: "power" - * @since Chrome 27 */ export namespace power { export enum Level { @@ -6880,8 +7000,9 @@ declare namespace chrome { // Printer Provider //////////////////// /** - * The chrome.printerProvider API exposes events used by print manager to query printers controlled by extensions, to query their capabilities and to submit print jobs to these printers. - * Permissions: "printerProvider" + * The `chrome.printerProvider` API exposes events used by print manager to query printers controlled by extensions, to query their capabilities and to submit print jobs to these printers. + * + * Permissions: "printerProvider" * @since Chrome 44 */ export namespace printerProvider { @@ -6948,12 +7069,12 @@ declare namespace chrome { // Printing //////////////////// /** - * Use the chrome.printing API to send print jobs to printers installed on Chromebook. + * Use the `chrome.printing` API to send print jobs to printers installed on Chromebook. - * Permissions: "printing" - * @platform ChromeOS only - * @since Chrome 81 - */ + * Permissions: "printing" + * @platform ChromeOS only + * @since Chrome 81 + */ export namespace printing { export interface GetPrinterInfoResponse { /** Printer capabilities in [CDD format](https://developers.google.com/cloud-print/docs/cdd#cdd-example). The property may be missing. */ @@ -7101,11 +7222,11 @@ declare namespace chrome { // Printing Metrics //////////////////// /** - * Use the chrome.printingMetrics API to fetch data about printing usage. + * Use the `chrome.printingMetrics` API to fetch data about printing usage. * * Permissions: "printingMetrics" * - * Note: This API is only for extensions pre-installed by policy. + * Note: Only available to policy installed extensions. * @platform ChromeOS only * @since Chrome 79 */ @@ -7231,69 +7352,180 @@ declare namespace chrome { // Privacy //////////////////// /** - * Use the chrome.privacy API to control usage of the features in Chrome that can affect a user's privacy. This API relies on the ChromeSetting prototype of the type API for getting and setting Chrome's configuration. - * Permissions: "privacy" - * The Chrome Privacy Whitepaper gives background detail regarding the features which this API can control. - * @since Chrome 18 + * Use the `chrome.privacy` API to control usage of the features in Chrome that can affect a user's privacy. This API relies on the ChromeSetting prototype of the type API for getting and setting Chrome's configuration. + * Note: The Chrome Privacy Whitepaper gives background detail regarding the features which this API can control. + * + * Permissions: "privacy" */ export namespace privacy { - export interface Services { - /** @since Chrome 20 */ - spellingServiceEnabled: chrome.types.ChromeSetting; - searchSuggestEnabled: chrome.types.ChromeSetting; - instantEnabled: chrome.types.ChromeSetting; - alternateErrorPagesEnabled: chrome.types.ChromeSetting; - safeBrowsingEnabled: chrome.types.ChromeSetting; - /** @deprecated since Chrome 70. Please use privacy.services.autofillAddressEnabled and privacy.services.autofillCreditCardEnabled. */ - autofillEnabled: chrome.types.ChromeSetting; - translationServiceEnabled: chrome.types.ChromeSetting; - /** @since Chrome 38 */ - passwordSavingEnabled: chrome.types.ChromeSetting; - /** @since Chrome 42 */ - hotwordSearchEnabled: chrome.types.ChromeSetting; - /** @since Chrome 42 */ - safeBrowsingExtendedReportingEnabled: chrome.types.ChromeSetting; - /** @since Chrome 70 */ - autofillAddressEnabled: chrome.types.ChromeSetting; - /** @since Chrome 70 */ - autofillCreditCardEnabled: chrome.types.ChromeSetting; - } - - export interface Network { - networkPredictionEnabled: chrome.types.ChromeSetting; - /** @deprecated since Chrome 48. Please use privacy.network.webRTCIPHandlingPolicy. */ - webRTCMultipleRoutesEnabled: chrome.types.ChromeSetting; - /** @deprecated since Chrome 48. Please use privacy.network.webRTCIPHandlingPolicy. */ - webRTCNonProxiedUdpEnabled: chrome.types.ChromeSetting; - /** @since Chrome 48 */ - webRTCIPHandlingPolicy: chrome.types.ChromeSetting; - } - - export interface Websites { - thirdPartyCookiesAllowed: chrome.types.ChromeSetting; - referrersEnabled: chrome.types.ChromeSetting; - hyperlinkAuditingEnabled: chrome.types.ChromeSetting; - /** @since Chrome 21. Available on Windows and ChromeOS only. */ - protectedContentEnabled: chrome.types.ChromeSetting; - /** @since Chrome 65 */ - doNotTrackEnabled: chrome.types.ChromeSetting; - } + /** + * The IP handling policy of WebRTC. + * @since Chrome 48 + */ + export enum IPHandlingPolicy { + DEFAULT = "default", + DEFAULT_PUBLIC_AND_PRIVATE_INTERFACES = "default_public_and_private_interfaces", + DEFAULT_PUBLIC_INTERFACE_ONLY = "default_public_interface_only", + DISABLE_NON_PROXIED_UDP = "disable_non_proxied_udp", + } /** Settings that enable or disable features that require third-party network services provided by Google and your default search provider. */ - export var services: Services; + export const services: { + /** + * If enabled, Chrome uses a web service to help resolve navigation errors. + * This preference's value is a boolean, defaulting to `true`. + */ + alternateErrorPagesEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome offers to automatically fill in addresses and other form data. + * This preference's value is a boolean, defaulting to `true`. + * @since Chrome 70 + */ + autofillAddressEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome offers to automatically fill in credit card forms. + * This preference's value is a boolean, defaulting to `true`. + * @since Chrome 70 + */ + autofillCreditCardEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome offers to automatically fill in forms. + * This preference's value is a boolean, defaulting to `true`. + * @deprecated since Chrome 70. Please use privacy.services.autofillAddressEnabled and privacy.services.autofillCreditCardEnabled. This remains for backward compatibility in this release and will be removed in the future */ + autofillEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, the password manager will ask if you want to save passwords. + * This preference's value is a boolean, defaulting to `true`. + */ + passwordSavingEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome does its best to protect you from phishing and malware. + * This preference's value is a boolean, defaulting to `true`. + */ + safeBrowsingEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome will send additional information to Google when SafeBrowsing blocks a page, such as the content of the blocked page. + * This preference's value is a boolean, defaulting to `false`. + */ + safeBrowsingExtendedReportingEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome sends the text you type into the Omnibox to your default search engine, which provides predictions of websites and searches that are likely completions of what you've typed so far. + * This preference's value is a boolean, defaulting to `true`. + */ + searchSuggestEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome uses a web service to help correct spelling errors. + * This preference's value is a boolean, defaulting to `false`. + */ + spellingServiceEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome offers to translate pages that aren't in a language you read. + * This preference's value is a boolean, defaulting to `true`. + */ + translationServiceEnabled: chrome.types.ChromeSetting; + }; + /** Settings that influence Chrome's handling of network connections in general. */ - export var network: Network; + export const network: { + /** + * If enabled, Chrome attempts to speed up your web browsing experience by pre-resolving DNS entries and preemptively opening TCP and SSL connections to servers. + * This preference only affects actions taken by Chrome's internal prediction service. It does not affect webpage-initiated prefectches or preconnects. + * This preference's value is a boolean, defaulting to `true`. + */ + networkPredictionEnabled: chrome.types.ChromeSetting; + + /** + * Allow users to specify the media performance/privacy tradeoffs which impacts how WebRTC traffic will be routed and how much local address information is exposed. + * This preference's value is of type IPHandlingPolicy, defaulting to `default`. + * @since Chrome 48 + */ + webRTCIPHandlingPolicy: chrome.types.ChromeSetting<`${IPHandlingPolicy}`>; + }; + /** Settings that determine what information Chrome makes available to websites. */ - export var websites: Websites; + export const websites: { + /** + * If disabled, the Attribution Reporting API and Private Aggregation API are deactivated. + * The value of this preference is of type boolean, and the default value is `true`. + * Extensions may only disable these APIs by setting the value to `false`. If you try setting these APIs to `true`, it will throw an error. + * @since Chrome 111 + */ + adMeasurementEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome sends 'Do Not Track' (`DNT: 1`) header with your requests. + * The value of this preference is of type boolean, and the default value is `false`. + * @since Chrome 65 + */ + doNotTrackEnabled: chrome.types.ChromeSetting; + + /** + * If disabled, the Fledge API is deactivated. + * The value of this preference is of type boolean, and the default value is `true`. + * Extensions may only disable this API by setting the value to `false`. If you try setting this API to `true`, it will throw an error. + * @since Chrome 111 + */ + fledgeEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome sends auditing pings when requested by a website (``). + * The value of this preference is of type boolean, and the default value is `true`. + */ + hyperlinkAuditingEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome provides a unique ID to plugins in order to run protected content. + * The value of this preference is of type boolean, and the default value is `true`. + * @platform Windows and ChromeOS only + */ + protectedContentEnabled: chrome.types.ChromeSetting; + + /** + * If enabled, Chrome sends `referer` headers with your requests. Yes, the name of this preference doesn't match the misspelled header. No, we're not going to change it. + * The value of this preference is of type boolean, and the default value is `true`. + */ + referrersEnabled: chrome.types.ChromeSetting; + + /** + * If disabled, Related Website Sets is deactivated. + * The value of this preference is of type boolean, and the default value is `true`. + * Extensions may only disable this API by setting the value to `false`. If you try setting this API to `true`, it will throw an error. + * @since Chrome 121 + */ + relatedWebsiteSetsEnabled: chrome.types.ChromeSetting; + + /** + * If disabled, Chrome blocks third-party sites from setting cookies. + * The value of this preference is of type boolean, and the default value is `true`. + */ + thirdPartyCookiesAllowed: chrome.types.ChromeSetting; + + /** + * If disabled, the Topics API is deactivated. + * The value of this preference is of type boolean, and the default value is `true`. + * Extensions may only disable this API by setting the value to `false`. If you try setting this API to `true`, it will throw an error. + * @since Chrome 111 + */ + topicsEnabled: chrome.types.ChromeSetting; + }; } //////////////////// // Proxy //////////////////// /** - * Use the chrome.proxy API to manage Chrome's proxy settings. This API relies on the ChromeSetting prototype of the type API for getting and setting the proxy configuration. - * Permissions: "proxy" - * @since Chrome 13 + * Use the `chrome.proxy` API to manage Chrome's proxy settings. This API relies on the ChromeSetting prototype of the type API for getting and setting the proxy configuration. + * + * Permissions: "proxy" */ export namespace proxy { /** An object holding proxy auto-config information. Exactly one of the fields should be non-empty. */ @@ -7359,19 +7591,130 @@ declare namespace chrome { export interface ProxyErrorEvent extends chrome.events.Event<(details: ErrorDetails) => void> {} - export var settings: chrome.types.ChromeSetting; + export var settings: chrome.types.ChromeSetting; /** Notifies about proxy errors. */ export var onProxyError: ProxyErrorEvent; } //////////////////// - // Search + // ReadingList //////////////////// /** - * Use the chrome.search API to search via the default provider. - * Permissions: "search" + * Use the `chrome.readingList` API to read from and modify the items in the Reading List. + * + * Permissions: "readingList" + * @since Chrome 120, MV3 */ + export namespace readingList { + export interface AddEntryOptions { + /** Will be `true` if the entry has been read. */ + hasBeenRead: boolean; + /** The title of the entry. */ + title: string; + /** The url of the entry. */ + url: string; + } + + export interface QueryInfo { + /** Indicates whether to search for read (`true`) or unread (`false`) items. */ + hasBeenRead?: boolean | undefined; + /** A title to search for. */ + title?: string | undefined; + /** A url to search for. */ + url?: string | undefined; + } + export interface ReadingListEntry { + /** The time the entry was created. Recorded in milliseconds since Jan 1, 1970. */ + creationTime: number; + /** Will be `true` if the entry has been read. */ + hasBeenRead: boolean; + /** The last time the entry was updated. This value is in milliseconds since Jan 1, 1970. */ + lastUpdateTime: number; + /** The title of the entry. */ + title: string; + /** The url of the entry. */ + url: string; + } + + export interface RemoveOptions { + /** The url to remove. */ + url: string; + } + + export interface UpdateEntryOptions { + /** The updated read status. The existing status remains if a value isn't provided. */ + hasBeenRead?: boolean | undefined; + /** The new title. The existing tile remains if a value isn't provided. */ + title?: string | undefined; + /** The url that will be updated. */ + url: string; + } + + /** + * Adds an entry to the reading list if it does not exist. + * @since Chrome 120, MV3 + * @param entry The entry to add to the reading list. + * @param callback + */ + export function addEntry(entry: AddEntryOptions): Promise; + export function addEntry(entry: AddEntryOptions, callback: () => void): void; + + /** + * Retrieves all entries that match the `QueryInfo` properties. Properties that are not provided will not be matched. + * @since Chrome 120, MV3 + * @param info The properties to search for. + * @param callback + */ + export function query(info: QueryInfo): Promise; + export function query(info: QueryInfo, callback: (entries: ReadingListEntry[]) => void): void; + + /** + * Removes an entry from the reading list if it exists. + * @since Chrome 120, MV3 + * @param info The entry to remove from the reading list. + * @param callback + */ + export function removeEntry(info: RemoveOptions): Promise; + export function removeEntry(info: RemoveOptions, callback: () => void): void; + + /** + * Updates a reading list entry if it exists. + * @since Chrome 120, MV3 + * @param info The entry to update. + * @param callback + */ + export function updateEntry(info: UpdateEntryOptions): Promise; + export function updateEntry(info: UpdateEntryOptions, callback: () => void): void; + + /** + * Triggered when a ReadingListEntry is added to the reading list. + * @since Chrome 120, MV3 + */ + export const onEntryAdded: chrome.events.Event<(entry: ReadingListEntry) => void>; + + /** + * Triggered when a ReadingListEntry is removed from the reading list. + * @since Chrome 120, MV3 + */ + export const onEntryRemoved: chrome.events.Event<(entry: ReadingListEntry) => void>; + + /** + * Triggered when a ReadingListEntry is updated in the reading list. + * @since Chrome 120, MV3 + */ + export const onEntryUpdated: chrome.events.Event<(entry: ReadingListEntry) => void>; + } + + //////////////////// + // Search + //////////////////// + /** + * Use the `chrome.search` API to search via the default provider. + * + * Permissions: "search" + * @since Chrome 87 + */ export namespace search { export type Disposition = "CURRENT_TAB" | "NEW_TAB" | "NEW_WINDOW"; @@ -7673,8 +8016,7 @@ declare namespace chrome { // Runtime //////////////////// /** - * Use the chrome.runtime API to retrieve the background page, return details about the manifest, and listen for and respond to events in the app or extension lifecycle. You can also use this API to convert the relative path of URLs to fully-qualified URLs. - * @since Chrome 22 + * Use the `chrome.runtime` API to retrieve the service worker, return details about the manifest, and listen for and respond to events in the extension lifecycle. You can also use this API to convert the relative path of URLs to fully-qualified URLs. */ export namespace runtime { /** This will be defined during an API method callback if there was an error */ @@ -7695,6 +8037,7 @@ declare namespace chrome { BACKGROUND = "BACKGROUND", OFFSCREEN_DOCUMENT = "OFFSCREEN_DOCUMENT", SIDE_PANEL = "SIDE_PANEL", + DEVELOPER_TOOLS = "DEVELOPER_TOOLS", } /** https://developer.chrome.com/docs/extensions/reference/api/runtime#type-OnInstalledReason */ export enum OnInstalledReason { @@ -8286,7 +8629,7 @@ declare namespace chrome { export function connectNative(application: string): Port; /** * Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set. - * @since MV3 + * @deprecated Background pages do not exist in MV3 extensions. */ export function getBackgroundPage(): Promise; /** Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set. */ @@ -8549,7 +8892,8 @@ declare namespace chrome { // Scripting //////////////////// /** - * Use the chrome.scripting API to execute script in different contexts. + * Use the `chrome.scripting` API to execute script in different contexts. + * * Permissions: "scripting" * @since Chrome 88, MV3 */ @@ -8801,9 +9145,9 @@ declare namespace chrome { // Sessions //////////////////// /** - * Use the chrome.sessions API to query and restore tabs and windows from a browsing session. - * Permissions: "sessions" - * @since Chrome 37 + * Use the `chrome.sessions` API to query and restore tabs and windows from a browsing session. + * + * Permissions: "sessions" */ export namespace sessions { export interface Filter { @@ -8905,9 +9249,9 @@ declare namespace chrome { // Storage //////////////////// /** - * Use the chrome.storage API to store, retrieve, and track changes to user data. - * Permissions: "storage" - * @since Chrome 20 + * Use the `chrome.storage` API to store, retrieve, and track changes to user data. + * + * Permissions: "storage" */ export namespace storage { /** NoInfer for old TypeScript versions */ @@ -8916,12 +9260,6 @@ declare namespace chrome { export {}; export interface StorageArea { - /** - * Gets the amount of space (in bytes) being used by one or more items. - * @param callback Callback with the amount of space being used by storage, or on failure (in which case runtime.lastError will be set). - * Parameter bytesInUse: Amount of space being used in storage, in bytes. - */ - getBytesInUse(callback: (bytesInUse: number) => void): void; /** * Gets the amount of space (in bytes) being used by one or more items. * @param keys Optional. A single key or list of keys to get the total usage for. An empty list will return 0. Pass in null to get the total usage of all of storage. @@ -8939,6 +9277,12 @@ declare namespace chrome { keys: keyof T | Array | null, callback: (bytesInUse: number) => void, ): void; + /** + * Gets the amount of space (in bytes) being used by one or more items. + * @param callback Callback with the amount of space being used by storage, or on failure (in which case runtime.lastError will be set). + * Parameter bytesInUse: Amount of space being used in storage, in bytes. + */ + getBytesInUse(callback: (bytesInUse: number) => void): void; /** * Removes all items from storage. * @return A void Promise @@ -8982,12 +9326,6 @@ declare namespace chrome { * Callback on success, or on failure (in which case runtime.lastError will be set). */ remove(keys: keyof T | Array, callback: () => void): void; - /** - * Gets the entire contents of storage. - * @param callback Callback with storage items, or on failure (in which case runtime.lastError will be set). - * Parameter items: Object with items in their key-value mappings. - */ - get(callback: (items: T) => void): void; /** * Gets one or more items from storage. * @param keys A single key to get, list of keys to get, or a dictionary specifying default values. @@ -9009,6 +9347,12 @@ declare namespace chrome { keys: NoInferX | Array> | Partial> | null, callback: (items: T) => void, ): void; + /** + * Gets the entire contents of storage. + * @param callback Callback with storage items, or on failure (in which case runtime.lastError will be set). + * Parameter items: Object with items in their key-value mappings. + */ + get(callback: (items: T) => void): void; /** * Sets the desired access level for the storage area. The default will be only trusted contexts. * @param accessOptions An object containing an accessLevel key which contains the access level of the storage area. @@ -9216,9 +9560,9 @@ declare namespace chrome { // System CPU //////////////////// /** - * Use the system.cpu API to query CPU metadata. + * Use the `system.cpu` API to query CPU metadata. + * * Permissions: "system.cpu" - * @since Chrome 32 */ export namespace system.cpu { export interface ProcessorUsage { @@ -9267,9 +9611,9 @@ declare namespace chrome { // System Memory //////////////////// /** - * The chrome.system.memory API. - * Permissions: "system.memory" - * @since Chrome 32 + * The `chrome.system.memory` API. + * + * Permissions: "system.memory" */ export namespace system.memory { export interface MemoryInfo { @@ -9293,9 +9637,9 @@ declare namespace chrome { // System Storage //////////////////// /** - * Use the chrome.system.storage API to query storage device information and be notified when a removable storage device is attached and detached. - * Permissions: "system.storage" - * @since Chrome 30 + * Use the `chrome.system.storage` API to query storage device information and be notified when a removable storage device is attached and detached. + * + * Permissions: "system.storage" */ export namespace system.storage { export interface StorageUnitInfo { @@ -9367,9 +9711,9 @@ declare namespace chrome { // System Display // //////////////////// /** - * Use the system.display API to query display metadata. + * Use the `system.display` API to query display metadata. + * * Permissions: "system.display" - * @since Chrome 30 */ export namespace system.display { export enum LayoutPosition { @@ -9845,11 +10189,11 @@ declare namespace chrome { // SystemLog //////////////////// /** - * Use the chrome.systemLog API to record Chrome system logs from extensions. + * Use the `chrome.systemLog` API to record Chrome system logs from extensions. * * Permissions: "systemLog" * - * Note: This API is only for extensions pre-installed by policy. + * Note: Only available to policy installed extensions. * @platform ChromeOS only * @since Chrome 125 */ @@ -9870,9 +10214,9 @@ declare namespace chrome { // TabCapture //////////////////// /** - * Use the chrome.tabCapture API to interact with tab media streams. - * Permissions: "tabCapture" - * @since Chrome 31 + * Use the `chrome.tabCapture` API to interact with tab media streams. + * + * Permissions: "tabCapture" */ export namespace tabCapture { export interface CaptureInfo { @@ -9939,9 +10283,9 @@ declare namespace chrome { // Tabs //////////////////// /** - * Use the chrome.tabs API to interact with the browser's tab system. You can use this API to create, modify, and rearrange tabs in the browser. + * Use the `chrome.tabs` API to interact with the browser's tab system. You can use this API to create, modify, and rearrange tabs in the browser. + * * Permissions: The majority of the chrome.tabs API can be used without declaring any permission. However, the "tabs" permission is required in order to populate the url, title, and favIconUrl properties of Tab. - * @since Chrome 5 */ export namespace tabs { /** @@ -9980,18 +10324,12 @@ declare namespace chrome { * @since Chrome 18 */ openerTabId?: number | undefined; - /** - * Optional. - * The title of the tab. This property is only present if the extension's manifest includes the "tabs" permission. - */ + /** The title of the tab. This property is only present if the extension has the `tabs` permission or has host permissions for the page. */ title?: string | undefined; - /** - * Optional. - * The URL the tab is displaying. This property is only present if the extension's manifest includes the "tabs" permission. - */ + /** The last committed URL of the main frame of the tab. This property is only present if the extension has the `tabs` permission or has host permissions for the page. May be an empty string if the tab has not yet committed. See also {@link Tab.pendingUrl}. */ url?: string | undefined; /** - * The URL the tab is navigating to, before it has committed. + * The URL the tab is navigating to, before it has committed. This property is only present if the extension has the `tabs` permission or has host permissions for the page and there is a pending navigation.The URL the tab is navigating to, before it has committed. * This property is only present if the extension's manifest includes the "tabs" permission and there is a pending navigation. * @since Chrome 79 */ @@ -10013,11 +10351,13 @@ declare namespace chrome { * @since Chrome 16 */ active: boolean; + /** The URL of the tab's favicon. This property is only present if the extension has the `tabs` permission or has host permissions for the page. It may also be an empty string if the tab is loading. */ + favIconUrl?: string | undefined; /** - * Optional. - * The URL of the tab's favicon. This property is only present if the extension's manifest includes the "tabs" permission. It may also be an empty string if the tab is loading. + * Whether the tab is frozen. A frozen tab cannot execute tasks, including event handlers or timers. It is visible in the tab strip and its content is loaded in memory. It is unfrozen on activation. + * @since Chrome 132 */ - favIconUrl?: string | undefined; + frozen: boolean; /** * Optional. * The ID of the tab. Tab IDs are unique within a browser session. Under some circumstances a Tab may not be assigned an ID, for example when querying foreign tabs using the sessions API, in which case a session ID may be present. Tab ID can also be set to chrome.tabs.TAB_ID_NONE for apps and devtools windows. @@ -10073,7 +10413,7 @@ declare namespace chrome { */ groupId: number; /** - * The last time the tab was accessed as the number of milliseconds since epoch. + * The last time the tab became active in its window as the number of milliseconds since epoch. * @since Chrome 121 */ lastAccessed?: number | undefined; @@ -10314,9 +10654,9 @@ declare namespace chrome { * @since Chrome 18 */ index?: number | undefined; - /** Optional. Match page titles against a pattern. */ + /** Match page titles against a pattern. This property is ignored if the extension does not have the `tabs` permission or host permissions for the page. */ title?: string | undefined; - /** Optional. Match tabs against one or more URL patterns. Note that fragment identifiers are not matched. */ + /** Match tabs against one or more URL patterns. Fragment identifiers are not matched. This property is ignored if the extension does not have the `tabs` permission or host permissions for the page. */ url?: string | string[] | undefined; /** * Optional. Whether the tabs are in the current window. @@ -10331,6 +10671,11 @@ declare namespace chrome { * @since Chrome 54 */ discarded?: boolean | undefined; + /** + * Whether the tabs are frozen. A frozen tab cannot execute tasks, including event handlers or timers. It is visible in the tab strip and its content is loaded in memory. It is unfrozen on activation. + * @since Chrome 132 + */ + frozen?: boolean; /** * Optional. * Whether the tabs can be discarded automatically by the browser when resources are low. @@ -10416,6 +10761,11 @@ declare namespace chrome { * @since Chrome 27 */ favIconUrl?: string | undefined; + /** + * The tab's new frozen state. + * @since Chrome 132 + */ + frozen?: boolean; /** * The tab's new title. * @since Chrome 48 @@ -10616,26 +10966,26 @@ declare namespace chrome { export function move(tabIds: number[], moveProperties: MoveProperties, callback: (tabs: Tab[]) => void): void; /** * Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified. - * @return The `update` method provides its result via callback or returned as a `Promise` (MV3 only). Details about the updated tab. The tabs.Tab object doesn't contain url, title and favIconUrl if the "tabs" permission has not been requested. + * @return The `update` method provides its result via callback or returned as a `Promise` (MV3 only). Details about the updated tab. The `url`, `pendingUrl`, `title` and `favIconUrl` properties are only included on the {@link tabs.Tab} object if the extension has the `tabs` permission or has host permissions for the page.. */ - export function update(updateProperties: UpdateProperties): Promise; + export function update(updateProperties: UpdateProperties): Promise; /** * Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified. * @param callback Optional. - * Optional parameter tab: Details about the updated tab. The tabs.Tab object doesn't contain url, title and favIconUrl if the "tabs" permission has not been requested. + * Optional parameter tab: Details about the updated tab. The `url`, `pendingUrl`, `title` and `favIconUrl` properties are only included on the {@link tabs.Tab} object if the extension has the `tabs` permission or has host permissions for the page.. */ export function update(updateProperties: UpdateProperties, callback: (tab?: Tab) => void): void; /** * Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified. * @param tabId Defaults to the selected tab of the current window. - * @return The `update` method provides its result via callback or returned as a `Promise` (MV3 only). Details about the updated tab. The tabs.Tab object doesn't contain url, title and favIconUrl if the "tabs" permission has not been requested. + * @return The `update` method provides its result via callback or returned as a `Promise` (MV3 only). Details about the updated tab. The `url`, `pendingUrl`, `title` and `favIconUrl` properties are only included on the {@link tabs.Tab} object if the extension has the `tabs` permission or has host permissions for the page.. */ - export function update(tabId: number, updateProperties: UpdateProperties): Promise; + export function update(tabId: number, updateProperties: UpdateProperties): Promise; /** * Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified. * @param tabId Defaults to the selected tab of the current window. * @param callback Optional. - * Optional parameter tab: Details about the updated tab. The tabs.Tab object doesn't contain url, title and favIconUrl if the "tabs" permission has not been requested. + * Optional parameter tab: Details about the updated tab. The `url`, `pendingUrl`, `title` and `favIconUrl` properties are only included on the {@link tabs.Tab} object if the extension has the `tabs` permission or has host permissions for the page.. */ export function update(tabId: number, updateProperties: UpdateProperties, callback: (tab?: Tab) => void): void; /** @@ -10725,13 +11075,13 @@ declare namespace chrome { * @param tabId The ID of the tab to reload; defaults to the selected tab of the current window. * @return The `reload` method provides its result via callback or returned as a `Promise` (MV3 only). It has no parameters. */ - export function reload(tabId: number, reloadProperties?: ReloadProperties): Promise; + export function reload(tabId: number): Promise; /** * Reload a tab. * @since Chrome 16 * @param tabId The ID of the tab to reload; defaults to the selected tab of the current window. */ - export function reload(tabId: number, reloadProperties?: ReloadProperties, callback?: () => void): void; + export function reload(tabId: number, callback?: () => void): void; /** * Reload the selected tab of the current window. * @since Chrome 16 @@ -10743,6 +11093,17 @@ declare namespace chrome { * @since Chrome 16 */ export function reload(reloadProperties: ReloadProperties, callback: () => void): void; + /** + * Reload the selected tab of the current window. + * @since Chrome 16 + * @return The `reload` method provides its result via callback or returned as a `Promise` (MV3 only). It has no parameters. + */ + export function reload(tabId: number, reloadProperties: ReloadProperties): Promise; + /** + * Reload the selected tab of the current window. + * @since Chrome 16 + */ + export function reload(tabId: number, reloadProperties: ReloadProperties, callback: () => void): void; /** * Reload the selected tab of the current window. * @since Chrome 16 @@ -10766,7 +11127,7 @@ declare namespace chrome { * @since Chrome 23 * @param tabId The ID of the tab which is to be duplicated. * @param callback Optional. - * Optional parameter tab: Details about the duplicated tab. The tabs.Tab object doesn't contain url, title and favIconUrl if the "tabs" permission has not been requested. + * Optional parameter tab: Details about the duplicated tab. The `url`, `pendingUrl`, `title` and `favIconUrl` properties are only included on the {@link tabs.Tab} object if the extension has the `tabs` permission or has host permissions for the page. */ export function duplicate(tabId: number, callback: (tab?: Tab) => void): void; /** @@ -11173,8 +11534,9 @@ declare namespace chrome { // Tab Groups //////////////////// /** - * Use the chrome.tabGroups API to interact with the browser's tab grouping system. You can use this API to modify and rearrange tab groups in the browser. To group and ungroup tabs, or to query what tabs are in groups, use the chrome.tabs API. - * Permissions: "tabGroups" + * Use the `chrome.tabGroups` API to interact with the browser's tab grouping system. You can use this API to modify and rearrange tab groups in the browser. To group and ungroup tabs, or to query what tabs are in groups, use the `chrome.tabs` API. + * + * Permissions: "tabGroups" * @since Chrome 89, MV3 */ export namespace tabGroups { @@ -11310,9 +11672,9 @@ declare namespace chrome { // Top Sites //////////////////// /** - * Use the chrome.topSites API to access the top sites that are displayed on the new tab page. - * Permissions: "topSites" - * @since Chrome 19 + * Use the `chrome.topSites` API to access the top sites (i.e. most visited sites) that are displayed on the new tab page. These do not include shortcuts customized by the user. + * + * Permissions: "topSites" */ export namespace topSites { /** An object encapsulating a most visited URL, such as the URLs on the new tab page. */ @@ -11337,9 +11699,9 @@ declare namespace chrome { // Text to Speech //////////////////// /** - * Use the chrome.tts API to play synthesized text-to-speech (TTS). See also the related ttsEngine API, which allows an extension to implement a speech engine. - * Permissions: "tts" - * @since Chrome 14 + * Use the `chrome.tts` API to play synthesized text-to-speech (TTS). See also the related ttsEngine API, which allows an extension to implement a speech engine. + * + * Permissions: "tts" */ export namespace tts { /** An event from the TTS engine to communicate the status of an utterance. */ @@ -11470,149 +11832,288 @@ declare namespace chrome { // Text to Speech Engine //////////////////// /** - * Use the chrome.ttsEngine API to implement a text-to-speech(TTS) engine using an extension. If your extension registers using this API, it will receive events containing an utterance to be spoken and other parameters when any extension or Chrome App uses the tts API to generate speech. Your extension can then use any available web technology to synthesize and output the speech, and send events back to the calling function to report the status. - * Permissions: "ttsEngine" - * @since Chrome 14 + * Use the `chrome.ttsEngine` API to implement a text-to-speech(TTS) engine using an extension. If your extension registers using this API, it will receive events containing an utterance to be spoken and other parameters when any extension or Chrome App uses the {@link tts} API to generate speech. Your extension can then use any available web technology to synthesize and output the speech, and send events back to the calling function to report the status. + * + * Permissions: "ttsEngine" */ export namespace ttsEngine { + /** + * Parameters containing an audio buffer and associated data. + * @since Chrome 92 + */ + export interface AudioBuffer { + /** The audio buffer from the text-to-speech engine. It should have length exactly audioStreamOptions.bufferSize and encoded as mono, at audioStreamOptions.sampleRate, and as linear pcm, 32-bit signed float i.e. the Float32Array type in javascript. */ + audioBuffer: ArrayBuffer; + /** The character index associated with this audio buffer. */ + charIndex?: number; + /** True if this audio buffer is the last for the text being spoken. */ + isLastBuffer?: boolean; + } + /** + * Contains the audio stream format expected to be produced by an engine. + * @since Chrome 92 + */ + export interface AudioStreamOptions { + /** The number of samples within an audio buffer. */ + bufferSize: number; + /** The sample rate expected in an audio buffer. */ + sampleRate: number; + } + + /** + * The install status of a voice. + * @since Chrome 132 + */ + export enum LanguageInstallStatus { + FAILED = "failed", + INSTALLED = "installed", + INSTALLING = "installing", + NOT_INSTALLED = "notInstalled", + } + + /** + * Install status of a language. + * @since Chrome 132 + */ + export interface LanguageStatus { + /** Detail about installation failures. Optionally populated if the language failed to install. */ + error?: string; + /** Installation status. */ + installStatus: `${LanguageInstallStatus}`; + /** Language string in the form of language code-region code, where the region may be omitted. Examples are en, en-AU, zh-CH. */ + lang: string; + } + + /** + * Options for uninstalling a given language. + * @since Chrome 132 + */ + export interface LanguageUninstallOptions { + /** True if the TTS client wants the language to be immediately uninstalled. The engine may choose whether or when to uninstall the language, based on this parameter and the requestor information. If false, it may use other criteria, such as recent usage, to determine when to uninstall. */ + uninstallImmediately: boolean; + } + + /** + * Options specified to the tts.speak() method. + * @since Chrome 92 + */ export interface SpeakOptions { - /** Optional. The language to be used for synthesis, in the form language-region. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'. */ - lang?: string | undefined; - /** Optional. The name of the voice to use for synthesis. */ - voiceName?: string | undefined; + /** The language to be used for synthesis, in the form language-region. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'. */ + lang?: string; + /** The name of the voice to use for synthesis. */ + voiceName?: string; /** - * Optional. Gender of voice for synthesized speech. - * One of: "male", or "female" + * Gender of voice for synthesized speech. + * @deprecated Gender is deprecated since Chrome 92 and will be ignored. */ - gender?: string | undefined; - /** Optional. Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0. */ - volume?: number | undefined; - /** - * Optional. - * Speaking rate relative to the default rate for this voice. 1.0 is the default rate, normally around 180 to 220 words per minute. 2.0 is twice as fast, and 0.5 is half as fast. This value is guaranteed to be between 0.1 and 10.0, inclusive. When a voice does not support this full range of rates, don't return an error. Instead, clip the rate to the range the voice supports. - */ - rate?: number | undefined; - /** Optional. Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2 being highest. 1.0 corresponds to this voice's default pitch. */ - pitch?: number | undefined; + gender?: `${VoiceGender}`; + /** Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0. */ + volume?: number; + /** Speaking rate relative to the default rate for this voice. 1.0 is the default rate, normally around 180 to 220 words per minute. 2.0 is twice as fast, and 0.5 is half as fast. This value is guaranteed to be between 0.1 and 10.0, inclusive. When a voice does not support this full range of rates, don't return an error. Instead, clip the rate to the range the voice supports. */ + rate?: number; + /** Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2 being highest. 1.0 corresponds to this voice's default pitch. */ + pitch?: number; } - export interface TtsEngineSpeakEvent extends - chrome.events.Event< - (utterance: string, options: SpeakOptions, sendTtsEvent: (event: chrome.tts.TtsEvent) => void) => void - > - {} + /** + * Identifier for the client requesting status. + * @since Chrome 131 + */ + export interface TtsClient { + /** Client making a language management request. For an extension, this is the unique extension ID. For Chrome features, this is the human-readable name of the feature. */ + id: string; + /** Type of requestor. */ + source: `${TtsClientSource}`; + } + + /** + * Type of requestor. + * @since Chrome 131 + */ + export enum TtsClientSource { + CHROMEFEATURE = "chromefeature", + EXTENSION = "extension", + } + + /** + * @since Chrome 54 + * @deprecated Gender is deprecated and will be ignored. + */ + export enum VoiceGender { + MALE = "male", + FEMALE = "female", + } + + /** + * Called by an engine when a language install is attempted, and when a language is uninstalled. Also called in response to a status request from a client. When a voice is installed or uninstalled, the engine should also call ttsEngine.updateVoices to register the voice. + * @since Chrome 132 + */ + export function updateLanguage(status: LanguageStatus): void; + + /** + * Called by an engine to update its list of voices. This list overrides any voices declared in this extension's manifest. + * @since Chrome 66 + */ + export function updateVoices(voices: tts.TtsVoice[]): void; + + /** + * Fired when a TTS client requests to install a new language. The engine should attempt to download and install the language, and call ttsEngine.updateLanguage with the result. On success, the engine should also call ttsEngine.updateVoices to register the newly available voices. + * @since Chrome 131 + */ + export const onInstallLanguageRequest: chrome.events.Event<(requestor: TtsClient, lang: string) => void>; + + /** + * Fired when a TTS client requests the install status of a language. + * @since Chrome 132 + */ + export const onLanguageStatusRequest: chrome.events.Event<(requestor: TtsClient, lang: string) => void>; + + /** Optional: if an engine supports the pause event, it should pause the current utterance being spoken, if any, until it receives a resume event or stop event. Note that a stop event should also clear the paused state. */ + export const onPause: chrome.events.Event<() => void>; + + /** Optional: if an engine supports the pause event, it should also support the resume event, to continue speaking the current utterance, if any. Note that a stop event should also clear the paused state. */ + export const onResume: chrome.events.Event<() => void>; /** Called when the user makes a call to tts.speak() and one of the voices from this extension's manifest is the first to match the options object. */ - export var onSpeak: TtsEngineSpeakEvent; - /** Fired when a call is made to tts.stop and this extension may be in the middle of speaking. If an extension receives a call to onStop and speech is already stopped, it should do nothing (not raise an error). If speech is in the paused state, this should cancel the paused state. */ - export var onStop: chrome.events.Event<() => void>; + export const onSpeak: chrome.events.Event< + (utterance: string, options: SpeakOptions, sendTtsEvent: (event: chrome.tts.TtsEvent) => void) => void + >; + /** - * Optional: if an engine supports the pause event, it should pause the current utterance being spoken, if any, until it receives a resume event or stop event. Note that a stop event should also clear the paused state. - * @since Chrome 29 + * Called when the user makes a call to tts.speak() and one of the voices from this extension's manifest is the first to match the options object. Differs from ttsEngine.onSpeak in that Chrome provides audio playback services and handles dispatching tts events. + * @since Chrome 92 */ - export var onPause: chrome.events.Event<() => void>; + + export const onSpeakWithAudioStream: chrome.events.Event< + ( + utterance: string, + options: SpeakOptions, + audioStreamOptions: AudioStreamOptions, + sendTtsAudio: (audioBufferParams: AudioBuffer) => void, + sendError: (errorMessage?: string) => void, + ) => void + >; + + /** Fired when a call is made to tts.stop and this extension may be in the middle of speaking. If an extension receives a call to onStop and speech is already stopped, it should do nothing (not raise an error). If speech is in the paused state, this should cancel the paused state. */ + export const onStop: chrome.events.Event<() => void>; + /** - * Optional: if an engine supports the pause event, it should also support the resume event, to continue speaking the current utterance, if any. Note that a stop event should also clear the paused state. - * @since Chrome 29 + * Fired when a TTS client indicates a language is no longer needed. + * @since Chrome 132 */ - export var onResume: chrome.events.Event<() => void>; + export const onUninstallLanguageRequest: chrome.events.Event< + (requestor: TtsClient, lang: string, uninstallOptions: LanguageUninstallOptions) => void + >; } //////////////////// // Types //////////////////// /** - * The chrome.types API contains type declarations for Chrome. - * @since Chrome 13 + * The `chrome.types` API contains type declarations for Chrome. */ export namespace types { - type settingsScope = "regular" | "regular_only" | "incognito_persistent" | "incognito_session_only" | undefined; + /** + * The scope of the ChromeSetting. One of + * * `regular`: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere), + * * `regular_only`: setting for the regular profile only (not inherited by the incognito profile), + * * `incognito_persistent`: setting for the incognito profile that survives browser restarts (overrides regular preferences) + * * `incognito_session_only`: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences). + * @since Chrome 44 + */ + export type ChromeSettingScope = "regular" | "regular_only" | "incognito_persistent" | "incognito_session_only"; - export interface ChromeSettingClearDetails { - /** - * Optional. - * The scope of the ChromeSetting. One of - * • regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere), - * • regular_only: setting for the regular profile only (not inherited by the incognito profile), - * • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences), - * • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences). - */ - scope?: settingsScope; - } + /** + * One of + * * `not_controllable`: cannot be controlled by any extension + * * `controlled_by_other_extensions`: controlled by extensions with higher precedence + * * `controllable_by_this_extension`: can be controlled by this extension + * * `controlled_by_this_extension`: controlled by this extension + * @since Chrome 44 + */ + export type LevelOfControl = + | "not_controllable" + | "controlled_by_other_extensions" + | "controllable_by_this_extension" + | "controlled_by_this_extension"; - export interface ChromeSettingSetDetails extends ChromeSettingClearDetails { + /** Which setting to change. */ + export interface ChromeSettingSetDetails { /** * The value of the setting. * Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type. */ - value: any; - /** - * Optional. - * The scope of the ChromeSetting. One of - * • regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere), - * • regular_only: setting for the regular profile only (not inherited by the incognito profile), - * • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences), - * • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences). - */ - scope?: settingsScope; + value: T; + /** Where to set the setting (default: regular). */ + scope?: ChromeSettingScope; } + /** Which setting to consider. */ export interface ChromeSettingGetDetails { - /** Optional. Whether to return the value that applies to the incognito session (default false). */ - incognito?: boolean | undefined; + /** Whether to return the value that applies to the incognito session (default false). */ + incognito?: boolean; } - /** - * @param details Details of the currently effective value. - */ - export type DetailsCallback = (details: ChromeSettingGetResultDetails) => void; - - export interface ChromeSettingGetResultDetails { - /** - * One of - * • not_controllable: cannot be controlled by any extension - * • controlled_by_other_extensions: controlled by extensions with higher precedence - * • controllable_by_this_extension: can be controlled by this extension - * • controlled_by_this_extension: controlled by this extension - */ - levelOfControl: - | "not_controllable" - | "controlled_by_other_extensions" - | "controllable_by_this_extension" - | "controlled_by_this_extension"; + /** Details of the currently effective value */ + export interface ChromeSettingGetResult { + /** The level of control of the setting. */ + levelOfControl: LevelOfControl; /** The value of the setting. */ - value: any; + value: T; /** - * Optional. * Whether the effective value is specific to the incognito session. * This property will only be present if the incognito property in the details parameter of get() was true. */ - incognitoSpecific?: boolean | undefined; + incognitoSpecific?: boolean; } - export interface ChromeSettingChangedEvent extends chrome.events.Event {} + /** Which setting to clear. */ + export interface ChromeSettingClearDetails { + /** Where to clear the setting (default: regular). */ + scope?: ChromeSettingScope; + } - /** An interface that allows access to a Chrome browser setting. See accessibilityFeatures for an example. */ - export interface ChromeSetting { + /** Details of the currently effective value. */ + export interface ChromeSettingOnChangeDetails { + /** + * Whether the effective value is specific to the incognito session. T + * his property will only be present if the incognito property in the details parameter of get() was true. + */ + incognitoSpecific?: boolean; + /** The value of the setting. */ + value: T; + /** The level of control of the setting. */ + levelOfControl: LevelOfControl; + } + + /** + * An interface that allows access to a Chrome browser setting. + * See {@link chrome.accessibilityFeatures} for an example. + */ + export interface ChromeSetting { /** * Sets the value of a setting. - * @param details Which setting to change. - * @param callback Optional. Called at the completion of the set operation. + * Can return its result via Promise in Manifest V3 or later since Chrome 96. */ - set(details: ChromeSettingSetDetails, callback?: Function): void; + set(details: ChromeSettingSetDetails, callback: () => void): void; + set(details: ChromeSettingSetDetails): Promise; + /** * Gets the value of a setting. - * @param details Which setting to consider. + * Can return its result via Promise in Manifest V3 or later since Chrome 96. */ - get(details: ChromeSettingGetDetails, callback?: DetailsCallback): void; + get(details: ChromeSettingGetDetails, callback: (details: ChromeSettingGetResult) => void): void; + get(details: ChromeSettingGetDetails): Promise>; + /** * Clears the setting, restoring any default value. - * @param details Which setting to clear. - * @param callback Optional. Called at the completion of the clear operation. + * Can return its result via Promise in Manifest V3 or later since Chrome 96. */ - clear(details: ChromeSettingClearDetails, callback?: Function): void; + clear(details: ChromeSettingClearDetails, callback: () => void): void; + clear(details: ChromeSettingClearDetails): Promise; + /** Fired after the setting changes. */ - onChange: ChromeSettingChangedEvent; + onChange: chrome.events.Event<(details: ChromeSettingOnChangeDetails) => void>; } } @@ -11620,9 +12121,10 @@ declare namespace chrome { // VPN Provider //////////////////// /** - * Use the chrome.vpnProvider API to implement a VPN client. - * Permissions: "vpnProvider" - * Important: This API works only on Chrome OS. + * Use the `chrome.vpnProvider` API to implement a VPN client. + * + * Permissions: "vpnProvider" + * @platform ChromeOS only * @since Chrome 43 */ export namespace vpnProvider { @@ -11711,9 +12213,10 @@ declare namespace chrome { // Wallpaper //////////////////// /** - * Use the chrome.wallpaper API to change the ChromeOS wallpaper. - * Permissions: "wallpaper" - * Important: This API works only on Chrome OS. + * Use the `chrome.wallpaper` API to change the ChromeOS wallpaper. + * + * Permissions: "wallpaper" + * @platform ChromeOS only * @since Chrome 43 */ export namespace wallpaper { @@ -11745,9 +12248,9 @@ declare namespace chrome { // Web Navigation //////////////////// /** - * Use the chrome.webNavigation API to receive notifications about the status of navigation requests in-flight. - * Permissions: "webNavigation" - * @since Chrome 16 + * Use the `chrome.webNavigation` API to receive notifications about the status of navigation requests in-flight. + * + * Permissions: "webNavigation" */ export namespace webNavigation { export interface GetFrameDetails { @@ -11958,11 +12461,19 @@ declare namespace chrome { // Web Request //////////////////// /** - * Use the chrome.webRequest API to observe and analyze traffic and to intercept, block, or modify requests in-flight. - * Permissions: "webRequest", host permissions - * @since Chrome 17 + * Use the `chrome.webRequest` API to observe and analyze traffic and to intercept, block, or modify requests in-flight. + * + * Permissions: "webRequest" + * + * Manifest: "host_permissions" */ export namespace webRequest { + interface WebRequestEvent + extends Omit, "addListener"> + { + addListener(callback: T, filter: RequestFilter, extraInfoSpec?: U): void; + } + /** How the requested resource will be used. */ export type ResourceType = | "main_frame" @@ -12161,82 +12672,45 @@ declare namespace chrome { error: string; } - export interface WebRequestBodyEvent extends - chrome.events.EventWithRequiredFilterInAddListener< - // eslint-disable-next-line @typescript-eslint/no-invalid-void-type - (details: WebRequestBodyDetails) => BlockingResponse | void - > - { - addListener( - // eslint-disable-next-line @typescript-eslint/no-invalid-void-type - callback: (details: WebRequestBodyDetails) => BlockingResponse | void, - filter: RequestFilter, - opt_extraInfoSpec?: string[], - ): void; - } + export type WebRequestBodyEvent = WebRequestEvent< + // eslint-disable-next-line @typescript-eslint/no-invalid-void-type + (details: WebRequestBodyDetails) => BlockingResponse | void, + string[] + >; - export interface WebRequestHeadersSynchronousEvent extends - chrome.events.EventWithRequiredFilterInAddListener< - // eslint-disable-next-line @typescript-eslint/no-invalid-void-type - (details: WebRequestHeadersDetails) => BlockingResponse | void - > - { - addListener( - // eslint-disable-next-line @typescript-eslint/no-invalid-void-type - callback: (details: WebRequestHeadersDetails) => BlockingResponse | void, - filter: RequestFilter, - opt_extraInfoSpec?: string[], - ): void; - } + export type WebRequestHeadersSynchronousEvent = WebRequestEvent< + // eslint-disable-next-line @typescript-eslint/no-invalid-void-type + (details: WebRequestHeadersDetails) => BlockingResponse | void, + string[] + >; - export interface WebRequestHeadersEvent - extends chrome.events.EventWithRequiredFilterInAddListener<(details: WebRequestHeadersDetails) => void> - { - addListener( - callback: (details: WebRequestHeadersDetails) => void, - filter: RequestFilter, - opt_extraInfoSpec?: string[], - ): void; - } + export type WebRequestHeadersEvent = WebRequestEvent< + (details: WebRequestHeadersDetails) => void, + string[] + >; - export interface _WebResponseHeadersEvent - extends chrome.events.EventWithRequiredFilterInAddListener<(details: T) => void> - { - addListener(callback: (details: T) => void, filter: RequestFilter, opt_extraInfoSpec?: string[]): void; - } + export type _WebResponseHeadersEvent = WebRequestEvent< + (details: T) => void, + string[] + >; - export interface WebResponseHeadersEvent extends - chrome.events.EventWithRequiredFilterInAddListener< - // eslint-disable-next-line @typescript-eslint/no-invalid-void-type - (details: WebResponseHeadersDetails) => BlockingResponse | void - > - { - addListener( - // eslint-disable-next-line @typescript-eslint/no-invalid-void-type - callback: (details: WebResponseHeadersDetails) => BlockingResponse | void, - filter: RequestFilter, - opt_extraInfoSpec?: string[], - ): void; - } + export type WebResponseHeadersEvent = WebRequestEvent< + // eslint-disable-next-line @typescript-eslint/no-invalid-void-type + (details: WebResponseHeadersDetails) => BlockingResponse | void, + string[] + >; - export interface WebResponseCacheEvent extends _WebResponseHeadersEvent {} + export type WebResponseCacheEvent = _WebResponseHeadersEvent; - export interface WebRedirectionResponseEvent extends _WebResponseHeadersEvent {} + export type WebRedirectionResponseEvent = _WebResponseHeadersEvent; - export interface WebAuthenticationChallengeEvent extends - chrome.events.EventWithRequiredFilterInAddListener< - (details: WebAuthenticationChallengeDetails, callback?: (response: BlockingResponse) => void) => void - > - { - addListener( - callback: ( - details: WebAuthenticationChallengeDetails, - callback?: (response: BlockingResponse) => void, - ) => void, - filter: RequestFilter, - opt_extraInfoSpec?: string[], - ): void; - } + export type WebAuthenticationChallengeEvent = WebRequestEvent< + ( + details: WebAuthenticationChallengeDetails, + callback?: (response: BlockingResponse) => void, + ) => void, + string[] + >; export interface WebResponseErrorEvent extends _WebResponseHeadersEvent {} @@ -12246,17 +12720,25 @@ declare namespace chrome { */ export var MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES: number; - /** Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often. */ - export function handlerBehaviorChanged(callback?: Function): void; + /** + * Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often. + * Can return its result via Promise in Manifest V3 or later since Chrome 116. + */ + export function handlerBehaviorChanged(): Promise; + export function handlerBehaviorChanged(callback: Function): void; /** Fired when a request is about to occur. */ - export var onBeforeRequest: WebRequestBodyEvent; + export const onBeforeRequest: WebRequestBodyEvent; + /** Fired before sending an HTTP request, once the request headers are available. This may occur after a TCP connection is made to the server, but before any HTTP data is sent. */ - export var onBeforeSendHeaders: WebRequestHeadersSynchronousEvent; + export const onBeforeSendHeaders: WebRequestHeadersSynchronousEvent; + /** Fired just before a request is going to be sent to the server (modifications of previous onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired). */ - export var onSendHeaders: WebRequestHeadersEvent; + export const onSendHeaders: WebRequestHeadersEvent; + /** Fired when HTTP response headers of a request have been received. */ - export var onHeadersReceived: WebResponseHeadersEvent; + export const onHeadersReceived: WebResponseHeadersEvent; + /** * Fired when an authentication failure is received. * The listener has three options: it can provide authentication credentials, it can cancel the request and display the error page, or it can take no action on the challenge. @@ -12265,15 +12747,19 @@ declare namespace chrome { * * Requires the `webRequestAuthProvider` permission. */ - export var onAuthRequired: WebAuthenticationChallengeEvent; + export const onAuthRequired: WebAuthenticationChallengeEvent; + /** Fired when the first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available. */ - export var onResponseStarted: WebResponseCacheEvent; + export const onResponseStarted: WebResponseCacheEvent; + /** Fired when a server-initiated redirect is about to occur. */ - export var onBeforeRedirect: WebRedirectionResponseEvent; + export const onBeforeRedirect: WebRedirectionResponseEvent; + /** Fired when a request is completed. */ - export var onCompleted: WebResponseCacheEvent; + export const onCompleted: WebResponseCacheEvent; + /** Fired when an error occurs. */ - export var onErrorOccurred: WebResponseErrorEvent; + export const onErrorOccurred: WebResponseErrorEvent; } //////////////////// @@ -12387,9 +12873,9 @@ declare namespace chrome { // Windows //////////////////// /** - * Use the chrome.windows API to interact with browser windows. You can use this API to create, modify, and rearrange windows in the browser. + * Use the `chrome.windows` API to interact with browser windows. You can use this API to create, modify, and rearrange windows in the browser. + * * Permissions: The chrome.windows API can be used without declaring any permission. However, the "tabs" permission is required in order to populate the url, title, and favIconUrl properties of Tab objects. - * @since Chrome 5 */ export namespace windows { export interface Window { @@ -12722,39 +13208,87 @@ declare namespace chrome { export var onBoundsChanged: WindowReferenceEvent; } + //////////////////// + // declarativeNetRequest + //////////////////// + /** + * The `chrome.declarativeNetRequest` API is used to block or modify network requests by specifying declarative rules. This lets extensions modify network requests without intercepting them and viewing their content, thus providing more privacy. + * + * Permissions: "declarativeNetRequest", "declarativeNetRequestWithHostAccess", "declarativeNetRequestFeedback" + * + * Manifest: "host_permissions" + * @since Chrome 84 + */ export namespace declarativeNetRequest { /** Ruleset ID for the dynamic rules added by the extension. */ - export const DYNAMIC_RULESET_ID: string; + export const DYNAMIC_RULESET_ID: "_dynamic"; - /** Time interval within which MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules calls can be made, specified in minutes. - * Additional calls will fail immediately and set runtime.lastError. - * Note: getMatchedRules calls associated with a user gesture are exempt from the quota. + /** + * Time interval within which `MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules` calls can be made, specified in minutes. + * Additional calls will fail immediately and set {@link runtime.lastError}. + * Note: `getMatchedRules` calls associated with a user gesture are exempt from the quota. */ - export const GETMATCHEDRULES_QUOTA_INTERVAL: number; + export const GETMATCHEDRULES_QUOTA_INTERVAL: 10; - /** The minimum number of static rules guaranteed to an extension across its enabled static rulesets. + /** + * The minimum number of static rules guaranteed to an extension across its enabled static rulesets. * Any rules above this limit will count towards the global rule limit. + * @since Chrome 89 */ - export const GUARANTEED_MINIMUM_STATIC_RULES: number; + export const GUARANTEED_MINIMUM_STATIC_RULES: 30000; - /** The number of times getMatchedRules can be called within a period of GETMATCHEDRULES_QUOTA_INTERVAL. */ - export const MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL: number; + /** The number of times `getMatchedRules` can be called within a period of `GETMATCHEDRULES_QUOTA_INTERVAL`. */ + export const MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL: 20; + + /** The maximum number of dynamic rules that an extension can add. */ + export const MAX_NUMBER_OF_DYNAMIC_RULES: 30000; + + /** + * The maximum number of static `Rulesets` an extension can enable at any one time. + * @since Chrome 94 + */ + export const MAX_NUMBER_OF_ENABLED_STATIC_RULESETS: 50; /** The maximum number of combined dynamic and session scoped rules an extension can add. */ - export const MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES: number; + export const MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES: 5000; - /** The maximum number of regular expression rules that an extension can add. + /** + * The maximum number of regular expression rules that an extension can add. * This limit is evaluated separately for the set of dynamic rules and those specified in the rule resources file. */ - export const MAX_NUMBER_OF_REGEX_RULES: number; + export const MAX_NUMBER_OF_REGEX_RULES: 1000; - /** The maximum number of static Rulesets an extension can specify as part of the "rule_resources" manifest key. */ - export const MAX_NUMBER_OF_STATIC_RULESETS: number; + /** + * The maximum number of session scoped rules that an extension can add. + * @since Chrome 120 + */ + export const MAX_NUMBER_OF_SESSION_RULES: 5000; - /** Ruleset ID for the session-scoped rules added by the extension. */ - export const SESSION_RULESET_ID: string; + /** The maximum number of static `Rulesets` an extension can specify as part of the `"rule_resources"` manifest key. */ + export const MAX_NUMBER_OF_STATIC_RULESETS: 100; + + /** + * The maximum number of "unsafe" dynamic rules that an extension can add. + * @since Chrome 120 + */ + export const MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES: 5000; + + /** + * The maximum number of "unsafe" session scoped rules that an extension can add. + * @since Chrome 120 + */ + export const MAX_NUMBER_OF_UNSAFE_SESSION_RULES: 5000; - /** This describes the HTTP request method of a network request. */ + /** + * Ruleset ID for the session-scoped rules added by the extension. + * @since Chrome 90 + */ + export const SESSION_RULESET_ID: "_session"; + + /** + * This describes the HTTP request method of a network request. + * @since Chrome 91 + */ export enum RequestMethod { CONNECT = "connect", DELETE = "delete", @@ -12764,6 +13298,7 @@ declare namespace chrome { PATCH = "patch", POST = "post", PUT = "put", + OTHER = "other", } /** This describes the resource type of the network request. */ @@ -12780,37 +13315,59 @@ declare namespace chrome { CSP_REPORT = "csp_report", MEDIA = "media", WEBSOCKET = "websocket", + WEBTRANSPORT = "webtransport", + WEBBUNDLE = "webbundle", OTHER = "other", } /** Describes the kind of action to take if a given RuleCondition matches. */ export enum RuleActionType { + /** Block the network request. */ BLOCK = "block", + /** Redirect the network request. */ REDIRECT = "redirect", + /** Allow the network request. The request won't be intercepted if there is an allow rule which matches it. */ ALLOW = "allow", + /** Upgrade the network request url's scheme to https if the request is http or ftp. */ UPGRADE_SCHEME = "upgradeScheme", + /** Modify request/response headers from the network request. */ MODIFY_HEADERS = "modifyHeaders", + /** Allow all requests within a frame hierarchy, including the frame request itself. */ ALLOW_ALL_REQUESTS = "allowAllRequests", } - /** Describes the reason why a given regular expression isn't supported. */ + /** + * Describes the reason why a given regular expression isn't supported. + * @since Chrome 87 + */ export enum UnsupportedRegexReason { + /** The regular expression is syntactically incorrect, or uses features not available in the RE2 syntax. */ SYNTAX_ERROR = "syntaxError", + /** The regular expression exceeds the memory limit. */ MEMORY_LIMIT_EXCEEDED = "memoryLimitExceeded", } - /** TThis describes whether the request is first or third party to the frame in which it originated. + /** + * This describes whether the request is first or third party to the frame in which it originated. * A request is said to be first party if it has the same domain (eTLD+1) as the frame in which the request originated. */ export enum DomainType { + /** The network request is first party to the frame in which it originated. */ FIRST_PARTY = "firstParty", + /* The network request is third party to the frame in which it originated. */ THIRD_PARTY = "thirdParty", } - /** This describes the possible operations for a "modifyHeaders" rule. */ + /** + * This describes the possible operations for a "modifyHeaders" rule. + * @since Chrome 86 + */ export enum HeaderOperation { + /** Adds a new entry for the specified header. This operation is not supported for request headers. */ APPEND = "append", + /** Sets a new value for the specified header, removing any existing headers with the same name. */ SET = "set", + /** Removes all entries for the specified header. */ REMOVE = "remove", } @@ -13065,6 +13622,18 @@ declare namespace chrome { * Note: this must be specified for allowAllRequests rules and may only include the sub_frame and main_frame resource types. */ resourceTypes?: ResourceType[] | undefined; + + /** + * Rule does not match if the request matches any response header condition in this list (if specified). If both `excludedResponseHeaders` and `responseHeaders` are specified, then the `excludedResponseHeaders` property takes precedence. + * @since Chrome 128 + */ + excludedResponseHeaders?: HeaderInfo[]; + + /** + * Rule matches if the request matches any response header condition in this list (if specified). + * @since Chrome 128 + */ + responseHeaders?: HeaderInfo[]; } export interface MatchedRule { @@ -13099,6 +13668,24 @@ declare namespace chrome { tabId?: number | undefined; } + /** @since Chrome 128 */ + export interface HeaderInfo { + /** If specified, this condition is not matched if the header exists but its value contains at least one element in this list. This uses the same match pattern syntax as `values`. */ + excludedValues?: string[]; + /** The name of the header. This condition matches on the name only if both `values` and `excludedValues` are not specified. */ + header: string; + /** + * If specified, this condition matches if the header's value matches at least one pattern in this list. This supports case-insensitive header value matching plus the following constructs: + * + * **'\*'** : Matches any number of characters. + * + * **'?'** : Matches zero or one character(s). + * + * **'\*'** and **'?'** can be escaped with a backslash, e.g. **'\\\*'** and **'\\?'** + */ + values?: string[]; + } + export interface ModifyHeaderInfo { /** The name of the header to be modified. */ header: string; @@ -13490,9 +14077,10 @@ declare namespace chrome { // SidePanel //////////////////// /** - * @since Chrome 114, MV3 - * https://developer.chrome.com/docs/extensions/reference/api/sidePanel + * Use the `chrome.sidePanel` API to host content in the browser's side panel alongside the main content of a webpage. + * * Permissions: "sidePanel" + * @since Chrome 114, MV3 */ export namespace sidePanel { export interface GetPanelOptions { @@ -13633,15 +14221,15 @@ declare namespace chrome { ): Promise; } - // Type definitions for chrome.userScripts API - + //////////////////// + // User Scripts + //////////////////// /** - * Availability: Chrome 120 beta. Manifest v3. - * https://developer.chrome.com/docs/extensions/reference/api/userScripts + * Use the `userScripts` API to execute user scripts in the User Scripts context. + * * Permissions: "userScripts" - * Description: "A user script is a bit of code injected into a web page to modify its appearance or behavior. Scripts are either created by users or downloaded from a script repository or a user script extension."" + * @since Chrome 120, MV3 */ - export namespace userScripts { /** * Execution environment for a user script. @@ -13679,7 +14267,7 @@ declare namespace chrome { id: string; /** Specifies wildcard patterns for pages this user script will be injected into. */ includeGlobs?: string[]; - /** The list of ScriptSource objects defining sources of scripts to be injected into matching pages. */ + /** The list of ScriptSource objects defining sources of scripts to be injected into matching pages. This property must be specified for {@link register}, and when specified it must be a non-empty array.*/ js: ScriptSource[]; /** Specifies which pages this user script will be injected into. See Match Patterns for more details on the syntax of these strings. This property must be specified for ${ref:register}. */ matches?: string[]; diff --git a/types/chrome/test/index.ts b/types/chrome/test/index.ts index bbb9dd91fd1624f..e93b3e8c9c99a3a 100644 --- a/types/chrome/test/index.ts +++ b/types/chrome/test/index.ts @@ -173,52 +173,6 @@ function printPage() { }); } -// https://developer.chrome.com/extensions/examples/extensions/catblock/background.js -function catBlock() { - var loldogs: string[]; - chrome.webRequest.onBeforeRequest.addListener( - function(info) { - console.log("Cat intercepted: " + info.url); - // Redirect the lolcat request to a random loldog URL. - var i = Math.round(Math.random() * loldogs.length); - return { redirectUrl: loldogs[i] }; - }, - // filters - { - urls: ["https://i.chzbgr.com/*"], - types: ["image"], - }, - // extraInfoSpec - ["blocking"], - ); -} - -// webNavigation.onSendHeaders.addListener example -function webRequestAddListenerMandatoryFilters() { - // @ts-expect-error - chrome.webRequest.onBeforeRequest.addListener(info => {}); - - chrome.webRequest.onSendHeaders.addListener(details => { - console.log( - (details.requestHeaders ?? [])[0].name, - details.documentId, - details.documentLifecycle, - details.frameType, - details.frameId, - details.initiator, - details.parentDocumentId, - details.parentFrameId, - details.requestId, - details.tabId, - details.timeStamp, - details.type, - details.url, - ); - }, { - urls: [""], - }, ["requestHeaders"]); -} - // webNavigation.onBeforeNavigate.addListener example function beforeRedditNavigation() { chrome.webNavigation.onBeforeNavigate.addListener( @@ -288,46 +242,35 @@ function executeScriptFramed() { chrome.tabs.insertCSS(tabId, { frameId, code }); } -// for chrome.tabs.TAB_ID_NONE -function realTabsOnly() { - chrome.webRequest.onBeforeRequest.addListener( - function(details) { - if (details.tabId === chrome.tabs.TAB_ID_NONE) { - console.log("Request not related to a tab. %o", details); - return; - } - // ... - }, - { - urls: [""], - }, - ); -} - -// contrived settings example +// https://developer.chrome.com/docs/extensions/reference/api/proxy function proxySettings() { - chrome.proxy.settings.get({ incognito: true }, details => { - var val = details.value; - var level: string = details.levelOfControl; - var incognito: boolean = details.incognitoSpecific!; + chrome.proxy.settings.get({ incognito: false }); // $ExpectType Promise> + chrome.proxy.settings.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult }); + // @ts-expect-error + chrome.proxy.settings.get({}, () => {}).then(() => {}); - // bare minimum set call - chrome.proxy.settings.set({ value: "something" }); - - // add a scope and callback - chrome.proxy.settings.set( - { - value: "something", - scope: "regular", - }, - () => {}, - ); + chrome.proxy.settings.set({ value: { mode: "" }, scope: "regular" }); // $ExpectType Promise + chrome.proxy.settings.set({ value: { mode: "" }, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.proxy.settings.set({ value: { mode: "" }, scope: "regular" }, () => {}).then(() => {}); - chrome.proxy.settings.clear({}); + chrome.proxy.settings.clear({ scope: "regular" }); // $ExpectType Promise + chrome.proxy.settings.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.proxy.settings.clear({ scope: "regular" }, () => {}).then(() => {}); - // clear with a scope set - chrome.proxy.settings.clear({ scope: "regular" }); + chrome.proxy.settings.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.proxy.settings.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.proxy.settings.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.proxy.settings.onChange.hasListeners(); // $ExpectType boolean } function testNotificationCreation() { @@ -879,6 +822,147 @@ async function testTtsVoice() { }); } +// https://developer.chrome.com/docs/extensions/reference/api/ttsEngine +function testTtsEngine() { + const TtsEvent: chrome.tts.TtsEvent = { + type: "start", + }; + + chrome.ttsEngine.LanguageInstallStatus.FAILED === "failed"; + chrome.ttsEngine.LanguageInstallStatus.INSTALLED === "installed"; + chrome.ttsEngine.LanguageInstallStatus.INSTALLING === "installing"; + chrome.ttsEngine.LanguageInstallStatus.NOT_INSTALLED === "notInstalled"; + + chrome.ttsEngine.TtsClientSource.CHROMEFEATURE === "chromefeature"; + chrome.ttsEngine.TtsClientSource.EXTENSION === "extension"; + + chrome.ttsEngine.VoiceGender.MALE === "male"; + chrome.ttsEngine.VoiceGender.FEMALE === "female"; + + chrome.ttsEngine.updateLanguage({ + lang: "en", + installStatus: "installed", + }); + chrome.ttsEngine.updateLanguage({ + lang: "en", + installStatus: chrome.ttsEngine.LanguageInstallStatus.INSTALLED, + }); + + chrome.ttsEngine.updateVoices([{ voiceName: "voice", lang: "en" }]); // $ExpectType void + + chrome.ttsEngine.onInstallLanguageRequest.addListener((requestor, lang) => { + requestor; // $ExpectType TtsClient + lang; // $ExpectType string + }); + chrome.ttsEngine.onInstallLanguageRequest.removeListener((requestor, lang) => { + requestor; // $ExpectType TtsClient + lang; // $ExpectType string + }); + chrome.ttsEngine.onInstallLanguageRequest.hasListener((requestor, lang) => { + requestor; // $ExpectType TtsClient + lang; // $ExpectType string + }); + chrome.ttsEngine.onInstallLanguageRequest.hasListeners(); // $ExpectType boolean + + chrome.ttsEngine.onLanguageStatusRequest.addListener((requestor, lang) => { + requestor; // $ExpectType TtsClient + lang; // $ExpectType string + }); + chrome.ttsEngine.onLanguageStatusRequest.removeListener((requestor, lang) => { + requestor; // $ExpectType TtsClient + lang; // $ExpectType string + }); + chrome.ttsEngine.onLanguageStatusRequest.hasListener((requestor, lang) => { + requestor; // $ExpectType TtsClient + lang; // $ExpectType string + }); + chrome.ttsEngine.onLanguageStatusRequest.hasListeners(); // $ExpectType boolean + + chrome.ttsEngine.onPause.addListener(() => {}); // $ExpectType void + chrome.ttsEngine.onPause.removeListener(() => {}); // $ExpectType void + chrome.ttsEngine.onPause.hasListener(() => {}); // $ExpectType boolean + chrome.ttsEngine.onPause.hasListeners(); // $ExpectType boolean + + chrome.ttsEngine.onResume.addListener(() => {}); // $ExpectType void + chrome.ttsEngine.onResume.removeListener(() => {}); // $ExpectType void + chrome.ttsEngine.onResume.hasListener(() => {}); // $ExpectType boolean + chrome.ttsEngine.onResume.hasListeners(); // $ExpectType boolean + + chrome.ttsEngine.onSpeak.addListener((utterance, options, sendTtsEvent) => { + utterance; // $ExpectType string + options; // $ExpectType SpeakOptions + sendTtsEvent(TtsEvent); + }); + chrome.ttsEngine.onSpeak.removeListener((utterance, options, sendTtsEvent) => { + utterance; // $ExpectType string + options; // $ExpectType SpeakOptions + sendTtsEvent(TtsEvent); + }); + chrome.ttsEngine.onSpeak.hasListener((utterance, options, sendTtsEvent) => { + utterance; // $ExpectType string + options; // $ExpectType SpeakOptions + sendTtsEvent(TtsEvent); + }); + chrome.ttsEngine.onSpeak.hasListeners(); // $ExpectType boolean + + const audioBuffer: chrome.ttsEngine.AudioBuffer = { + audioBuffer: new ArrayBuffer(8), + charIndex: 0, + isLastBuffer: false, + }; + + chrome.ttsEngine.onSpeakWithAudioStream.addListener( + (utterance, options, audioStreamOptions, sendTtsAudio, sendError) => { + utterance; // $ExpectType string + options; // $ExpectType SpeakOptions + audioStreamOptions; // $ExpectType AudioStreamOptions + sendTtsAudio(audioBuffer); + sendError("error"); + }, + ); + chrome.ttsEngine.onSpeakWithAudioStream.removeListener( + (utterance, options, audioStreamOptions, sendTtsAudio, sendError) => { + utterance; // $ExpectType string + options; // $ExpectType SpeakOptions + audioStreamOptions; // $ExpectType AudioStreamOptions + sendTtsAudio(audioBuffer); + sendError("error"); + }, + ); + chrome.ttsEngine.onSpeakWithAudioStream.hasListener( + (utterance, options, audioStreamOptions, sendTtsAudio, sendError) => { + utterance; // $ExpectType string + options; // $ExpectType SpeakOptions + audioStreamOptions; // $ExpectType AudioStreamOptions + sendTtsAudio(audioBuffer); + sendError("error"); + }, + ); + chrome.ttsEngine.onSpeakWithAudioStream.hasListeners(); // $ExpectType boolean + + chrome.ttsEngine.onStop.addListener(() => {}); // $ExpectType void + chrome.ttsEngine.onStop.removeListener(() => {}); // $ExpectType void + chrome.ttsEngine.onStop.hasListener(() => {}); // $ExpectType boolean + chrome.ttsEngine.onStop.hasListeners(); // $ExpectType boolean + + chrome.ttsEngine.onUninstallLanguageRequest.addListener((requestor, lang, uninstallOptions) => { + requestor; // $ExpectType TtsClient + lang; // $ExpectType string + uninstallOptions; // $ExpectType LanguageUninstallOptions + }); + chrome.ttsEngine.onUninstallLanguageRequest.removeListener((requestor, lang, uninstallOptions) => { + requestor; // $ExpectType TtsClient + lang; // $ExpectType string + uninstallOptions; // $ExpectType LanguageUninstallOptions + }); + chrome.ttsEngine.onUninstallLanguageRequest.hasListener((requestor, lang, uninstallOptions) => { + requestor; // $ExpectType TtsClient + lang; // $ExpectType string + uninstallOptions; // $ExpectType LanguageUninstallOptions + }); + chrome.ttsEngine.onUninstallLanguageRequest.hasListeners(); // $ExpectType boolean +} + chrome.runtime.onInstalled.addListener((details) => { details; // $ExpectType InstalledDetails details.reason; // $ExpectType OnInstalledReason @@ -1045,30 +1129,6 @@ async function testSearchForPromise() { } } -// https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/ -async function testDeclarativeNetRequest() { - chrome.declarativeNetRequest.getDynamicRules(rules => { - // $ExpectType Rule[] - rules; - - const rule = rules[0]; - rule.action; // $ExpectType RuleAction - rule.condition; // $ExpectType RuleCondition - rule.id; // $ExpectType number - rule.priority; // $ExpectType number | undefined - }); - - chrome.declarativeNetRequest.getAvailableStaticRuleCount(count => { - // $ExpectType number - count; - }); - - chrome.declarativeNetRequest.getEnabledRulesets(sets => { - // $ExpectType string[] - sets; - }); -} - // https://developer.chrome.com/docs/extensions/reference/browserAction/#method-enable function testBrowserAcionEnable() { chrome.browserAction.enable(); @@ -1261,19 +1321,23 @@ function testBrowserAcionSetTitle() { chrome.browserAction.setTitle(undefined); } -// https://developer.chrome.com/docs/extensions/reference/action/ -async function testActionForPromise() { +// https://developer.chrome.com/docs/extensions/reference/api/action +async function testAction() { await chrome.action.disable(); await chrome.action.enable(); await chrome.action.disable(0); await chrome.action.enable(0); await chrome.action.getBadgeBackgroundColor({}); await chrome.action.getBadgeText({}); + chrome.action.getBadgeTextColor({}, (color: chrome.action.ColorArray) => void 0); + chrome.action.getBadgeTextColor({ tabId: 0 }, (color: chrome.action.ColorArray) => void 0); const getBackTextColor1: chrome.action.ColorArray = await chrome.action.getBadgeTextColor({}); const getBackTextColor2: chrome.action.ColorArray = await chrome.action.getBadgeTextColor({ tabId: 0 }); await chrome.action.getPopup({}); await chrome.action.getTitle({}); await chrome.action.getUserSettings(); + chrome.action.isEnabled(0, (isEnabled: boolean) => void 0); + chrome.action.isEnabled(undefined, (isEnabled: boolean) => void 0); const isEnabled1: boolean = await chrome.action.isEnabled(); const isEnabled2: boolean = await chrome.action.isEnabled(0); await chrome.action.openPopup({ windowId: 1 }); @@ -1283,14 +1347,28 @@ async function testActionForPromise() { await chrome.action.setIcon({ path: { "16": "path/to/icon.png" } }); await chrome.action.setPopup({ popup: "popup1" }); await chrome.action.setTitle({ title: "title1" }); -} -// https://developer.chrome.com/docs/extensions/reference/action/ -async function testActionForCallback() { - chrome.action.getBadgeTextColor({}, (color: chrome.action.ColorArray) => void 0); - chrome.action.getBadgeTextColor({ tabId: 0 }, (color: chrome.action.ColorArray) => void 0); - chrome.action.isEnabled(0, (isEnabled: boolean) => void 0); - chrome.action.isEnabled(undefined, (isEnabled: boolean) => void 0); + chrome.action.onClicked.addListener((tab) => { + tab; // $ExpectType Tab + }); + chrome.action.onClicked.removeListener((tab) => { + tab; // $ExpectType Tab + }); + chrome.action.onClicked.hasListener((tab) => { + tab; // $ExpectType Tab + }); + chrome.action.onClicked.hasListeners(); + + chrome.action.onUserSettingsChanged.addListener((change) => { + change; // $ExpectType UserSettingsChange + }); + chrome.action.onUserSettingsChanged.removeListener((change) => { + change; // $ExpectType UserSettingsChange + }); + chrome.action.onUserSettingsChanged.hasListener((change) => { + change; // $ExpectType UserSettingsChange + }); + chrome.action.onUserSettingsChanged.hasListeners(); } // https://developer.chrome.com/docs/extensions/reference/alarms/ @@ -1418,24 +1496,73 @@ async function testBrowserActionForPromise() { await chrome.browserAction.getPopup({}); } -// https://developer.chrome.com/docs/extensions/reference/cookies -async function testCookieForPromise() { - await chrome.cookies.getAllCookieStores(); - await chrome.cookies.getAll({}); - await chrome.cookies.getAll({ partitionKey: {} }); - await chrome.cookies.set({ url: "url1" }); - await chrome.cookies.set({ name: "test-cookie", url: "https://example.com", partitionKey: {} }); - await chrome.cookies.remove({ url: "url1", name: "name1" }); - await chrome.cookies.remove({ - name: "test-cookie", +// https://developer.chrome.com/docs/extensions/reference/api/cookies +async function testCookie() { + const cookieDetails: chrome.cookies.CookieDetails = { url: "https://example.com", + name: "example", partitionKey: { topLevelSite: "https://example.com", hasCrossSiteAncestor: false, }, + }; + + chrome.cookies.get(cookieDetails); // $ExpectType Promise + chrome.cookies.get(cookieDetails, (cookie) => { + cookie; // $ExpectType Cookie | null + }); + // @ts-expect-error + chrome.cookies.get(cookieDetails, () => {}).then(() => {}); + + chrome.cookies.getAll(cookieDetails); // $ExpectType Promise + chrome.cookies.getAll(cookieDetails, (cookies) => { + cookies; // $ExpectType Cookie[] + }); + // @ts-expect-error + chrome.cookies.getAll(cookieDetails, () => {}).then(() => {}); + + chrome.cookies.getAllCookieStores(); // $ExpectType Promise + chrome.cookies.getAllCookieStores((cookieStores) => { + cookieStores; // $ExpectType CookieStore[] + }); + // @ts-expect-error + chrome.cookies.getAllCookieStores(() => {}).then(() => {}); + + const frameDetails: chrome.cookies.FrameDetails = { + tabId: 0, + }; + + chrome.cookies.getPartitionKey(frameDetails); // $ExpectType Promise<{ partitionKey: CookiePartitionKey }> + chrome.cookies.getPartitionKey(frameDetails, ({ partitionKey }) => { + partitionKey; // $ExpectType CookiePartitionKey + }); + // @ts-expect-error + chrome.cookies.getPartitionKey(frameDetails, () => {}).then(() => {}); + + chrome.cookies.remove(cookieDetails); // $ExpectType Promise + chrome.cookies.remove(cookieDetails, (details) => { + details; // $ExpectType CookieDetails + }); + // @ts-expect-error + chrome.cookies.remove(cookieDetails, () => {}).then(() => {}); + + chrome.cookies.set(cookieDetails); // $ExpectType Promise + chrome.cookies.set(cookieDetails, (cookie) => { + cookie; // $ExpectType Cookie | null + }); + // @ts-expect-error + chrome.cookies.set(cookieDetails, () => {}).then(() => {}); + + chrome.cookies.onChanged.addListener((changeInfo) => { + changeInfo; // $ExpectType CookieChangeInfo + }); + chrome.cookies.onChanged.removeListener((changeInfo) => { + changeInfo; // $ExpectType CookieChangeInfo }); - await chrome.cookies.get({ url: "url1", name: "name1" }); - await chrome.cookies.get({ url: "url1", name: "name1", partitionKey: {} }); + chrome.cookies.onChanged.hasListener((changeInfo) => { + changeInfo; // $ExpectType CookieChangeInfo + }); + chrome.cookies.onChanged.hasListeners(); // $ExpectType boolean } // https://developer.chrome.com/docs/extensions/reference/management @@ -1670,164 +1797,637 @@ function testSystemLog() { chrome.systemLog.add({ message: "" }, () => {}).then(() => {}); } -// https://developer.chrome.com/docs/extensions/reference/tabs -async function testTabsForPromise() { - await chrome.tabs.executeScript({}); - await chrome.tabs.executeScript(0, {}); - await chrome.tabs.get(0); - await chrome.tabs.getAllInWindow(); - await chrome.tabs.getAllInWindow(0); - await chrome.tabs.getCurrent(); // $ExpectType Tab | undefined - await chrome.tabs.getSelected(); - await chrome.tabs.getSelected(0); - await chrome.tabs.create({}); - await chrome.tabs.duplicate(0); // $ExpectType Tab | undefined - await chrome.tabs.move(0, { index: 0 }); - await chrome.tabs.move([0], { index: 0 }); - await chrome.tabs.update({}); - await chrome.tabs.update(0, {}); - await chrome.tabs.remove(0); - await chrome.tabs.remove([0]); - await chrome.tabs.captureVisibleTab(); - await chrome.tabs.captureVisibleTab(0); - await chrome.tabs.captureVisibleTab({}); - await chrome.tabs.captureVisibleTab(0, {}); - await chrome.tabs.reload(0, {}); - await chrome.tabs.reload({}); - await chrome.tabs.reload(); - await chrome.tabs.insertCSS({}); - await chrome.tabs.insertCSS(0, {}); - await chrome.tabs.highlight({ tabs: 0 }); - await chrome.tabs.query({}); - await chrome.tabs.detectLanguage(); - await chrome.tabs.detectLanguage(0); - await chrome.tabs.setZoom(0); - await chrome.tabs.setZoom(0, 0); - await chrome.tabs.getZoom(); - await chrome.tabs.getZoom(0); - await chrome.tabs.setZoomSettings({}); - await chrome.tabs.setZoomSettings(0, {}); - await chrome.tabs.getZoomSettings(); - await chrome.tabs.getZoomSettings(0); - await chrome.tabs.discard(0); - await chrome.tabs.goForward(); - await chrome.tabs.goForward(0); - await chrome.tabs.goBack(); - await chrome.tabs.goBack(0); - await chrome.tabs.group({}); - await chrome.tabs.ungroup(0); -} +// https://developer.chrome.com/docs/extensions/reference/api/tabs +async function testTabs() { + const tabId = 0; + const windowId = 0; + const groupId = 0; + const frameId = 0; + const documentId = "id"; -// https://developer.chrome.com/docs/extensions/reference/tabGroups -async function testTabGroupsForPromise() { - await chrome.tabGroups.get(0); - await chrome.tabGroups.move(0, { index: 0 }); - await chrome.tabGroups.query({}); - await chrome.tabGroups.update(0, {}); -} + const windowCaptureOptions: chrome.tabs.CaptureVisibleTabOptions = { + quality: 100, + format: "jpeg", + }; -// https://developer.chrome.com/docs/extensions/reference/windows -async function testWindowsForPromise() { - await chrome.windows.get(0); - await chrome.windows.get(0, {}); - await chrome.windows.getCurrent(); - await chrome.windows.getCurrent({}); - await chrome.windows.create(); - await chrome.windows.create({}); - await chrome.windows.getAll(); - await chrome.windows.getAll({}); - await chrome.windows.update(0, {}); - await chrome.windows.remove(0); - await chrome.windows.getLastFocused(); - await chrome.windows.getLastFocused({}); -} + chrome.tabs.captureVisibleTab(); // $ExpectType Promise + chrome.tabs.captureVisibleTab(windowId); // $ExpectType Promise + chrome.tabs.captureVisibleTab(windowCaptureOptions); // $ExpectType Promise + chrome.tabs.captureVisibleTab(windowId, windowCaptureOptions); // $ExpectType Promise + chrome.tabs.captureVisibleTab((dataUrl) => { + dataUrl; // $ExpectType string + }); + chrome.tabs.captureVisibleTab(windowId, (dataUrl) => { + dataUrl; // $ExpectType string + }); + chrome.tabs.captureVisibleTab(windowCaptureOptions, (dataUrl) => { + dataUrl; // $ExpectType string + }); + chrome.tabs.captureVisibleTab(windowId, windowCaptureOptions, (dataUrl) => { + dataUrl; // $ExpectType string + }); + // @ts-expect-error + chrome.tabs.captureVisibleTab(windowCaptureOptions, windowId); + // @ts-expect-error + chrome.tabs.captureVisibleTab(() => {}).then(() => {}); -// https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest -async function testDeclarativeNetRequestForPromise() { - await chrome.declarativeNetRequest.getAvailableStaticRuleCount(); - await chrome.declarativeNetRequest.getDynamicRules(); - await chrome.declarativeNetRequest.getEnabledRulesets(); - await chrome.declarativeNetRequest.getMatchedRules({}); - await chrome.declarativeNetRequest.getMatchedRules(); - await chrome.declarativeNetRequest.getSessionRules(); - await chrome.declarativeNetRequest.isRegexSupported({ regex: "regex1" }); - await chrome.declarativeNetRequest.setExtensionActionOptions({}); - await chrome.declarativeNetRequest.updateDynamicRules({}); - await chrome.declarativeNetRequest.updateEnabledRulesets({}); - await chrome.declarativeNetRequest.updateSessionRules({}); -} + const connectInfo: chrome.tabs.ConnectInfo = { + name: "name", + frameId, + }; -async function testDynamicRules() { - await chrome.declarativeNetRequest.updateDynamicRules({}); - await chrome.declarativeNetRequest.updateDynamicRules({ - addRules: [{ - action: { - type: chrome.declarativeNetRequest.RuleActionType.ALLOW, - }, - condition: { - initiatorDomains: ["www.example.com"], - tabIds: [2, 3, 76], - }, - id: 2, - priority: 3, - }], + chrome.tabs.connect(tabId); // $ExpectType Port + chrome.tabs.connect(tabId, connectInfo); // $ExpectType Port + + const createProperties: chrome.tabs.CreateProperties = { + index: 0, + }; + + chrome.tabs.create(createProperties); // $ExpectType Promise + chrome.tabs.create(createProperties, (tab) => { + tab; // $ExpectType Tab }); + // @ts-expect-error + chrome.tabs.create(() => {}).then(() => {}); - await chrome.declarativeNetRequest.updateDynamicRules({ - addRules: [{ - action: { - type: chrome.declarativeNetRequest.RuleActionType.MODIFY_HEADERS, - requestHeaders: [{ - header: "X-Test-Header", - operation: chrome.declarativeNetRequest.HeaderOperation.SET, - value: "test-value", - }], - }, - condition: { - resourceTypes: [chrome.declarativeNetRequest.ResourceType.MAIN_FRAME], - domains: ["www.example.com"], - }, - id: 2, - priority: 3, - }], + chrome.tabs.detectLanguage(); // $ExpectType Promise + chrome.tabs.detectLanguage(tabId); // $ExpectType Promise + chrome.tabs.detectLanguage((language) => { + language; // $ExpectType string }); -} + chrome.tabs.detectLanguage(tabId, (language) => { + language; // $ExpectType string + }); + // @ts-expect-error + chrome.tabs.detectLanguage(() => {}).then(() => {}); -// https://developer.chrome.com/docs/extensions/reference/storage -function testStorageForPromise() { - chrome.storage.sync.getBytesInUse().then(() => {}); - chrome.storage.sync.getBytesInUse(null).then(() => {}); - chrome.storage.sync.getBytesInUse("testKey").then(() => {}); - chrome.storage.sync.getBytesInUse(["testKey"]).then(() => {}); + chrome.tabs.discard(); // $ExpectType Promise + chrome.tabs.discard(tabId); // $ExpectType Promise + chrome.tabs.discard((tab) => { + tab; // $ExpectType Tab + }); + chrome.tabs.discard(tabId, (tab) => { + tab; // $ExpectType Tab + }); + // @ts-expect-error + chrome.tabs.discard(() => {}).then(() => {}); - chrome.storage.sync.clear().then(() => {}); + chrome.tabs.duplicate(tabId); // $ExpectType Promise + chrome.tabs.duplicate(tabId, (tab) => { + tab; // $ExpectType Tab | undefined + }); + // @ts-expect-error + chrome.tabs.duplicate(() => {}).then(() => {}); - chrome.storage.sync.set({ testKey: "testValue" }).then(() => {}); + chrome.tabs.get(tabId); // $ExpectType Promise + chrome.tabs.get(tabId, (tab) => { + tab; // $ExpectType Tab + }); + // @ts-expect-error + chrome.tabs.get(() => {}).then(() => {}); - chrome.storage.sync.remove("testKey").then(() => {}); - chrome.storage.sync.remove(["testKey"]).then(() => {}); + chrome.tabs.getCurrent(); // $ExpectType Promise + chrome.tabs.getCurrent((tab) => { + tab; // $ExpectType Tab | undefined + }); + // @ts-expect-error + chrome.tabs.getCurrent(() => {}).then(() => {}); - chrome.storage.sync.get().then(() => {}); - chrome.storage.sync.get(null).then(() => {}); - chrome.storage.sync.get("testKey").then(() => {}); - chrome.storage.sync.get(["testKey"]).then(() => {}); - chrome.storage.sync.get({ testKey: "testDefaultValue" }).then(() => {}); + chrome.tabs.getZoom(); // $ExpectType Promise + chrome.tabs.getZoom(tabId); // $ExpectType Promise + chrome.tabs.getZoom((zoomFactor) => { + zoomFactor; // $ExpectType number + }); + chrome.tabs.getZoom(tabId, (zoomFactor) => { + zoomFactor; // $ExpectType number + }); + // @ts-expect-error + chrome.tabs.getZoom(() => {}).then(() => {}); - chrome.storage.sync.setAccessLevel({ accessLevel: chrome.storage.AccessLevel.TRUSTED_AND_UNTRUSTED_CONTEXTS }).then( - () => {}, - ); -} + chrome.tabs.getZoomSettings(); // $ExpectType Promise + chrome.tabs.getZoomSettings(tabId); // $ExpectType Promise + chrome.tabs.getZoomSettings((zoomSettings) => { + zoomSettings; // $ExpectType ZoomSettings + }); + chrome.tabs.getZoomSettings(tabId, (zoomSettings) => { + zoomSettings; // $ExpectType ZoomSettings + }); + // @ts-expect-error + chrome.tabs.getZoomSettings(() => {}).then(() => {}); -// https://developer.chrome.com/docs/extensions/reference/api/runtime#method-getContexts -function testRunTimeGetContexts() { - const options = { incognito: true, tabIds: [1, 2, 3] }; + chrome.tabs.goBack(); // $ExpectType Promise + chrome.tabs.goBack(tabId); // $ExpectType Promise + chrome.tabs.goBack(() => {}); // $ExpectType void + chrome.tabs.goBack(tabId, () => {}); // $ExpectType void + // @ts-expect-error + chrome.tabs.goBack(() => {}).then(() => {}); - chrome.runtime.getContexts(options); -} + chrome.tabs.goForward(); // $ExpectType Promise + chrome.tabs.goForward(tabId); // $ExpectType Promise + chrome.tabs.goForward(() => {}); // $ExpectType void + chrome.tabs.goForward(tabId, () => {}); // $ExpectType void -// https://developer.chrome.com/docs/extensions/reference/runtime/#method-sendMessage -function testRuntimeSendMessage() { - const options = { includeTlsChannelId: true }; + const groupOptions: chrome.tabs.GroupOptions = { + createProperties: { + windowId, + }, + groupId, + tabIds: [tabId], + }; + + chrome.tabs.group(groupOptions); // $ExpectType Promise + chrome.tabs.group(groupOptions, (groupId) => { + groupId; // $ExpectType number + }); + // @ts-expect-error + chrome.tabs.group(() => {}).then(() => {}); + + const highlightInfo: chrome.tabs.HighlightInfo = { + windowId, + tabs: [tabId], + }; + + chrome.tabs.highlight(highlightInfo); // $ExpectType Promise + chrome.tabs.highlight(highlightInfo, (window) => { + window; // $ExpectType Window + }); + // @ts-expect-error + chrome.tabs.highlight(() => {}).then(() => {}); + + const moveProperties: chrome.tabs.MoveProperties = { + index: 0, + windowId, + }; + + chrome.tabs.move(tabId, moveProperties); // $ExpectType Promise + chrome.tabs.move([tabId], moveProperties); // $ExpectType Promise + chrome.tabs.move(tabId, moveProperties, (tab) => { + tab; // $ExpectType Tab + }); + chrome.tabs.move([tabId], moveProperties, (tabs) => { + tabs; // $ExpectType Tab[] + }); + // @ts-expect-error + chrome.tabs.move(() => {}).then(() => {}); + + const queryInfo: chrome.tabs.QueryInfo = { + active: true, + audible: true, + autoDiscardable: true, + currentWindow: true, + discarded: true, + frozen: true, + groupId, + highlighted: true, + index: 0, + lastFocusedWindow: true, + muted: true, + pinned: true, + status: "complete", + title: "title", + url: "url", + windowId, + windowType: "normal", + }; + + chrome.tabs.query(queryInfo); // $ExpectType Promise + chrome.tabs.query(queryInfo, (tabs) => { + tabs; // $ExpectType Tab[] + }); + // @ts-expect-error + chrome.tabs.query(() => {}).then(() => {}); + + const reloadProperties: chrome.tabs.ReloadProperties = { + bypassCache: true, + }; + + chrome.tabs.reload(); // $ExpectType Promise + chrome.tabs.reload(tabId); // $ExpectType Promise + chrome.tabs.reload(reloadProperties); // $ExpectType Promise + chrome.tabs.reload(tabId, reloadProperties); // $ExpectType Promise + chrome.tabs.reload(tabId, () => {}); // $ExpectType void + chrome.tabs.reload(reloadProperties, () => {}); // $ExpectType void + chrome.tabs.reload(tabId, reloadProperties, () => {}); // $ExpectType void + // @ts-expect-error + chrome.tabs.reload(() => {}).then(() => {}); + + chrome.tabs.remove(tabId); // $ExpectType Promise + chrome.tabs.remove([tabId]); // $ExpectType Promise + chrome.tabs.remove(tabId, () => {}); // $ExpectType void + chrome.tabs.remove([tabId], () => {}); // $ExpectType void + // @ts-expect-error + chrome.tabs.remove(() => {}).then(() => {}); + + const message = "Hello World"; + + chrome.tabs.sendMessage(tabId, message); // $ExpectType Promise + chrome.tabs.sendMessage(tabId, message, { frameId }); // $ExpectType Promise + chrome.tabs.sendMessage(tabId, message, { documentId }); // $ExpectType Promise + chrome.tabs.sendMessage(tabId, message, (response) => { + response; // $ExpectType any + }); + chrome.tabs.sendMessage(tabId, message, { frameId }, (response) => { + response; // $ExpectType any + }); + chrome.tabs.sendMessage(tabId, message, { documentId }, (response) => { + response; // $ExpectType any + }); + chrome.tabs.sendMessage(tabId, message); // $ExpectType Promise + chrome.tabs.sendMessage(tabId, message, (response) => { + response; // $ExpectType number + }); + // @ts-expect-error message should be a number + chrome.tabs.sendMessage(tabId, message); + // @ts-expect-error + chrome.tabs.sendMessage(() => {}).then(() => {}); + + const zoomFactor = 2; + + chrome.tabs.setZoom(zoomFactor); // $ExpectType Promise + chrome.tabs.setZoom(tabId, zoomFactor); // $ExpectType Promise + chrome.tabs.setZoom(zoomFactor, () => {}); // $ExpectType void + chrome.tabs.setZoom(tabId, zoomFactor, () => {}); // $ExpectType void + // @ts-expect-error + chrome.tabs.setZoom(() => {}).then(() => {}); + + const zoomSettings: chrome.tabs.ZoomSettings = { + mode: "automatic", + scope: "per-origin", + defaultZoomFactor: 1, + }; + + chrome.tabs.setZoomSettings(zoomSettings); // $ExpectType Promise + chrome.tabs.setZoomSettings(tabId, zoomSettings); // $ExpectType Promise + chrome.tabs.setZoomSettings(zoomSettings, () => {}); // $ExpectType void + chrome.tabs.setZoomSettings(tabId, zoomSettings, () => {}); // $ExpectType void + // @ts-expect-error + chrome.tabs.setZoomSettings(() => {}).then(() => {}); + + chrome.tabs.ungroup(tabId); // $ExpectType Promise + chrome.tabs.ungroup([tabId]); // $ExpectType Promise + chrome.tabs.ungroup(tabId, () => {}); // $ExpectType void + chrome.tabs.ungroup([tabId], () => {}); // $ExpectType void + // @ts-expect-error + chrome.tabs.ungroup(() => {}).then(() => {}); + + const updateProperties: chrome.tabs.UpdateProperties = { + active: true, + autoDiscardable: true, + highlighted: true, + muted: true, + openerTabId: tabId, + pinned: true, + url: "url", + }; + + chrome.tabs.update(updateProperties); // $ExpectType Promise + chrome.tabs.update(tabId, updateProperties); // $ExpectType Promise + chrome.tabs.update(updateProperties, (tab) => { + tab; // $ExpectType Tab | undefined + }); + chrome.tabs.update(tabId, updateProperties, (tab) => { + tab; // $ExpectType Tab | undefined + }); + // @ts-expect-error + chrome.tabs.update(() => {}).then(() => {}); + + chrome.tabs.onActivated.addListener((activeInfo) => { + activeInfo; // $ExpectType TabActiveInfo + }); + chrome.tabs.onActivated.removeListener((activeInfo) => { + activeInfo; // $ExpectType TabActiveInfo + }); + chrome.tabs.onActivated.hasListener((activeInfo) => { + activeInfo; // $ExpectType TabActiveInfo + }); + chrome.tabs.onActivated.hasListeners(); // $ExpectType boolean + + chrome.tabs.onAttached.addListener((tabId, attachInfo) => { + tabId; // $ExpectType number + attachInfo; // $ExpectType TabAttachInfo + }); + chrome.tabs.onAttached.removeListener((tabId, attachInfo) => { + tabId; // $ExpectType number + attachInfo; // $ExpectType TabAttachInfo + }); + chrome.tabs.onAttached.hasListener((tabId, attachInfo) => { + tabId; // $ExpectType number + attachInfo; // $ExpectType TabAttachInfo + }); + chrome.tabs.onAttached.hasListeners(); // $ExpectType boolean + + chrome.tabs.onCreated.addListener((tab) => { + tab; // $ExpectType Tab + }); + chrome.tabs.onCreated.removeListener((tab) => { + tab; // $ExpectType Tab + }); + chrome.tabs.onCreated.hasListener((tab) => { + tab; // $ExpectType Tab + }); + chrome.tabs.onCreated.hasListeners(); // $ExpectType boolean + + chrome.tabs.onDetached.addListener((tabId, detachInfo) => { + tabId; // $ExpectType number + detachInfo; // $ExpectType TabDetachInfo + }); + chrome.tabs.onDetached.removeListener((tabId, detachInfo) => { + tabId; // $ExpectType number + detachInfo; // $ExpectType TabDetachInfo + }); + chrome.tabs.onDetached.hasListener((tabId, detachInfo) => { + tabId; // $ExpectType number + detachInfo; // $ExpectType TabDetachInfo + }); + chrome.tabs.onDetached.hasListeners(); // $ExpectType boolean + + chrome.tabs.onHighlighted.addListener((highlightInfo) => { + highlightInfo; // $ExpectType TabHighlightInfo + }); + chrome.tabs.onHighlighted.removeListener((highlightInfo) => { + highlightInfo; // $ExpectType TabHighlightInfo + }); + chrome.tabs.onHighlighted.hasListener((highlightInfo) => { + highlightInfo; // $ExpectType TabHighlightInfo + }); + chrome.tabs.onHighlighted.hasListeners(); // $ExpectType boolean + + chrome.tabs.onMoved.addListener((tabId, moveInfo) => { + tabId; // $ExpectType number + moveInfo; // $ExpectType TabMoveInfo + }); + chrome.tabs.onMoved.removeListener((tabId, moveInfo) => { + tabId; // $ExpectType number + moveInfo; // $ExpectType TabMoveInfo + }); + chrome.tabs.onMoved.hasListener((tabId, moveInfo) => { + tabId; // $ExpectType number + moveInfo; // $ExpectType TabMoveInfo + }); + chrome.tabs.onMoved.hasListeners(); // $ExpectType boolean + + chrome.tabs.onRemoved.addListener((tabId, removeInfo) => { + tabId; // $ExpectType number + removeInfo; // $ExpectType TabRemoveInfo + }); + chrome.tabs.onRemoved.removeListener((tabId, removeInfo) => { + tabId; // $ExpectType number + removeInfo; // $ExpectType TabRemoveInfo + }); + chrome.tabs.onRemoved.hasListener((tabId, removeInfo) => { + tabId; // $ExpectType number + removeInfo; // $ExpectType TabRemoveInfo + }); + chrome.tabs.onRemoved.hasListeners(); // $ExpectType boolean + + chrome.tabs.onReplaced.addListener((addedTabId, removedTabId) => { + addedTabId; // $ExpectType number + removedTabId; // $ExpectType number + }); + chrome.tabs.onReplaced.removeListener((addedTabId, removedTabId) => { + addedTabId; // $ExpectType number + removedTabId; // $ExpectType number + }); + chrome.tabs.onReplaced.hasListener((addedTabId, removedTabId) => { + addedTabId; // $ExpectType number + removedTabId; // $ExpectType number + }); + chrome.tabs.onReplaced.hasListeners(); // $ExpectType boolean + + chrome.tabs.onUpdated.addListener((tabId, changeInfo, tab) => { + tabId; // $ExpectType number + changeInfo; // $ExpectType TabChangeInfo + tab; // $ExpectType Tab + }); + chrome.tabs.onUpdated.removeListener((tabId, changeInfo, tab) => { + tabId; // $ExpectType number + changeInfo; // $ExpectType TabChangeInfo + tab; // $ExpectType Tab + }); + chrome.tabs.onUpdated.hasListener((tabId, changeInfo, tab) => { + tabId; // $ExpectType number + changeInfo; // $ExpectType TabChangeInfo + tab; // $ExpectType Tab + }); + chrome.tabs.onUpdated.hasListeners(); // $ExpectType boolean + + chrome.tabs.onZoomChange.addListener((zoomChangeInfo) => { + zoomChangeInfo; // $ExpectType ZoomChangeInfo + }); + chrome.tabs.onZoomChange.removeListener((zoomChangeInfo) => { + zoomChangeInfo; // $ExpectType ZoomChangeInfo + }); + chrome.tabs.onZoomChange.hasListener((zoomChangeInfo) => { + zoomChangeInfo; // $ExpectType ZoomChangeInfo + }); + chrome.tabs.onZoomChange.hasListeners(); // $ExpectType boolean +} + +// https://developer.chrome.com/docs/extensions/reference/tabGroups +async function testTabGroupsForPromise() { + await chrome.tabGroups.get(0); + await chrome.tabGroups.move(0, { index: 0 }); + await chrome.tabGroups.query({}); + await chrome.tabGroups.update(0, {}); +} + +// https://developer.chrome.com/docs/extensions/reference/windows +async function testWindowsForPromise() { + await chrome.windows.get(0); + await chrome.windows.get(0, {}); + await chrome.windows.getCurrent(); + await chrome.windows.getCurrent({}); + await chrome.windows.create(); + await chrome.windows.create({}); + await chrome.windows.getAll(); + await chrome.windows.getAll({}); + await chrome.windows.update(0, {}); + await chrome.windows.remove(0); + await chrome.windows.getLastFocused(); + await chrome.windows.getLastFocused({}); +} + +// https://developer.chrome.com/docs/extensions/reference/api/declarativeNetRequest +async function testDeclarativeNetRequest() { + chrome.declarativeNetRequest.DYNAMIC_RULESET_ID === "_dynamic"; + + chrome.declarativeNetRequest.DomainType.FIRST_PARTY === "firstParty"; + chrome.declarativeNetRequest.DomainType.THIRD_PARTY === "thirdParty"; + + chrome.declarativeNetRequest.GETMATCHEDRULES_QUOTA_INTERVAL === 10; + + chrome.declarativeNetRequest.GUARANTEED_MINIMUM_STATIC_RULES === 30000; + + chrome.declarativeNetRequest.HeaderOperation.APPEND === "append"; + chrome.declarativeNetRequest.HeaderOperation.REMOVE === "remove"; + chrome.declarativeNetRequest.HeaderOperation.SET === "set"; + + chrome.declarativeNetRequest.MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL === 20; + + chrome.declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES === 5000; + + chrome.declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_RULES === 30000; + + chrome.declarativeNetRequest.MAX_NUMBER_OF_ENABLED_STATIC_RULESETS === 50; + + chrome.declarativeNetRequest.MAX_NUMBER_OF_REGEX_RULES === 1000; + + chrome.declarativeNetRequest.MAX_NUMBER_OF_SESSION_RULES === 5000; + + chrome.declarativeNetRequest.MAX_NUMBER_OF_STATIC_RULESETS === 100; + + chrome.declarativeNetRequest.MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES === 5000; + + chrome.declarativeNetRequest.MAX_NUMBER_OF_UNSAFE_SESSION_RULES === 5000; + + chrome.declarativeNetRequest.RequestMethod.CONNECT === "connect"; + chrome.declarativeNetRequest.RequestMethod.DELETE === "delete"; + chrome.declarativeNetRequest.RequestMethod.GET === "get"; + chrome.declarativeNetRequest.RequestMethod.HEAD === "head"; + chrome.declarativeNetRequest.RequestMethod.OPTIONS === "options"; + chrome.declarativeNetRequest.RequestMethod.OTHER === "other"; + chrome.declarativeNetRequest.RequestMethod.PATCH === "patch"; + chrome.declarativeNetRequest.RequestMethod.POST === "post"; + chrome.declarativeNetRequest.RequestMethod.PUT === "put"; + + chrome.declarativeNetRequest.ResourceType.CSP_REPORT === "csp_report"; + chrome.declarativeNetRequest.ResourceType.FONT === "font"; + chrome.declarativeNetRequest.ResourceType.IMAGE === "image"; + chrome.declarativeNetRequest.ResourceType.MAIN_FRAME === "main_frame"; + chrome.declarativeNetRequest.ResourceType.MEDIA === "media"; + chrome.declarativeNetRequest.ResourceType.OBJECT === "object"; + chrome.declarativeNetRequest.ResourceType.OTHER === "other"; + chrome.declarativeNetRequest.ResourceType.PING === "ping"; + chrome.declarativeNetRequest.ResourceType.SCRIPT === "script"; + chrome.declarativeNetRequest.ResourceType.STYLESHEET === "stylesheet"; + chrome.declarativeNetRequest.ResourceType.SUB_FRAME === "sub_frame"; + chrome.declarativeNetRequest.ResourceType.WEBBUNDLE === "webbundle"; + chrome.declarativeNetRequest.ResourceType.WEBSOCKET === "websocket"; + chrome.declarativeNetRequest.ResourceType.WEBTRANSPORT === "webtransport"; + chrome.declarativeNetRequest.ResourceType.XMLHTTPREQUEST === "xmlhttprequest"; + + chrome.declarativeNetRequest.RuleActionType.ALLOW === "allow"; + chrome.declarativeNetRequest.RuleActionType.ALLOW_ALL_REQUESTS === "allowAllRequests"; + chrome.declarativeNetRequest.RuleActionType.BLOCK === "block"; + chrome.declarativeNetRequest.RuleActionType.MODIFY_HEADERS === "modifyHeaders"; + chrome.declarativeNetRequest.RuleActionType.REDIRECT === "redirect"; + chrome.declarativeNetRequest.RuleActionType.UPGRADE_SCHEME === "upgradeScheme"; + + chrome.declarativeNetRequest.SESSION_RULESET_ID === "_session"; + + chrome.declarativeNetRequest.UnsupportedRegexReason.MEMORY_LIMIT_EXCEEDED === "memoryLimitExceeded"; + chrome.declarativeNetRequest.UnsupportedRegexReason.SYNTAX_ERROR === "syntaxError"; + + await chrome.declarativeNetRequest.getAvailableStaticRuleCount(); + chrome.declarativeNetRequest.getAvailableStaticRuleCount(count => { + // $ExpectType number + count; + }); + await chrome.declarativeNetRequest.getDynamicRules(); + chrome.declarativeNetRequest.getDynamicRules(rules => { + // $ExpectType Rule[] + rules; + + const rule = rules[0]; + rule.action; // $ExpectType RuleAction + rule.condition; // $ExpectType RuleCondition + rule.id; // $ExpectType number + rule.priority; // $ExpectType number | undefined + rule.condition.excludedResponseHeaders; // $ExpectType HeaderInfo[] | undefined + rule.condition.responseHeaders; // $ExpectType HeaderInfo[] | undefined + }); + + await chrome.declarativeNetRequest.getEnabledRulesets(); + chrome.declarativeNetRequest.getEnabledRulesets(sets => { + // $ExpectType string[] + sets; + }); + await chrome.declarativeNetRequest.getMatchedRules({}); + await chrome.declarativeNetRequest.getMatchedRules(); + await chrome.declarativeNetRequest.getSessionRules(); + await chrome.declarativeNetRequest.isRegexSupported({ regex: "regex1" }); + await chrome.declarativeNetRequest.setExtensionActionOptions({}); + await chrome.declarativeNetRequest.updateDynamicRules({}); + await chrome.declarativeNetRequest.updateEnabledRulesets({}); + await chrome.declarativeNetRequest.updateSessionRules({}); + + await chrome.declarativeNetRequest.updateDynamicRules({}); + await chrome.declarativeNetRequest.updateDynamicRules({ + addRules: [{ + action: { + type: chrome.declarativeNetRequest.RuleActionType.ALLOW, + }, + condition: { + initiatorDomains: ["www.example.com"], + tabIds: [2, 3, 76], + }, + id: 2, + priority: 3, + }], + }); + + await chrome.declarativeNetRequest.updateDynamicRules({ + addRules: [{ + action: { + type: chrome.declarativeNetRequest.RuleActionType.MODIFY_HEADERS, + requestHeaders: [{ + header: "X-Test-Header", + operation: chrome.declarativeNetRequest.HeaderOperation.SET, + value: "test-value", + }], + }, + condition: { + resourceTypes: [chrome.declarativeNetRequest.ResourceType.MAIN_FRAME], + domains: ["www.example.com"], + }, + id: 2, + priority: 3, + }], + }); +} + +// https://developer.chrome.com/docs/extensions/reference/storage +function testStorageForPromise() { + chrome.storage.sync.getBytesInUse().then(() => {}); + chrome.storage.sync.getBytesInUse(null).then(() => {}); + chrome.storage.sync.getBytesInUse("testKey").then(() => {}); + chrome.storage.sync.getBytesInUse(["testKey"]).then(() => {}); + + chrome.storage.sync.clear().then(() => {}); + + chrome.storage.sync.set({ testKey: "testValue" }).then(() => {}); + + chrome.storage.sync.remove("testKey").then(() => {}); + chrome.storage.sync.remove(["testKey"]).then(() => {}); + + chrome.storage.sync.get().then(() => {}); + chrome.storage.sync.get(null).then(() => {}); + chrome.storage.sync.get("testKey").then(() => {}); + chrome.storage.sync.get(["testKey"]).then(() => {}); + chrome.storage.sync.get({ testKey: "testDefaultValue" }).then(() => {}); + + chrome.storage.sync.setAccessLevel({ accessLevel: chrome.storage.AccessLevel.TRUSTED_AND_UNTRUSTED_CONTEXTS }).then( + () => {}, + ); +} + +// https://developer.chrome.com/docs/extensions/reference/api/runtime#method-getContexts +function testRuntimeGetContexts() { + chrome.runtime.ContextType.TAB === "TAB"; + chrome.runtime.ContextType.POPUP === "POPUP"; + chrome.runtime.ContextType.BACKGROUND === "BACKGROUND"; + chrome.runtime.ContextType.OFFSCREEN_DOCUMENT === "OFFSCREEN_DOCUMENT"; + chrome.runtime.ContextType.SIDE_PANEL === "SIDE_PANEL"; + chrome.runtime.ContextType.DEVELOPER_TOOLS === "DEVELOPER_TOOLS"; + + const options = { incognito: true, tabIds: [1, 2, 3] }; + + chrome.runtime.getContexts(options); +} + +// https://developer.chrome.com/docs/extensions/reference/runtime/#method-sendMessage +function testRuntimeSendMessage() { + const options = { includeTlsChannelId: true }; chrome.runtime.sendMessage("Hello World!").then(() => {}); chrome.runtime.sendMessage("Hello World!", console.log); @@ -1872,23 +2472,6 @@ function testRuntimeSendNativeMessage() { chrome.runtime.sendNativeMessage("application", console.log, (num: number) => alert(num + 1)); } -function testTabsSendMessage() { - chrome.tabs.sendMessage(1, "Hello World!"); - chrome.tabs.sendMessage(2, "Hello World!").then(() => {}); - chrome.tabs.sendMessage(3, "Hello World!", console.log); - chrome.tabs.sendMessage(4, "Hello World!", {}).then(() => {}); - chrome.tabs.sendMessage(5, "Hello World!", {}, console.log); - chrome.tabs.sendMessage(6, "Hello World!", { frameId: 1 }, console.log); - chrome.tabs.sendMessage(7, "Hello World!", { documentId: "id" }, console.log); - chrome.tabs.sendMessage(8, "Hello World!", { documentId: "id", frameId: 0 }, console.log); - chrome.tabs.sendMessage(6, "Hello World!", console.log); - chrome.tabs.sendMessage(7, "Hello World!", console.log); - // @ts-expect-error - chrome.tabs.sendMessage(8, "Hello World!", console.log); - // @ts-expect-error - chrome.tabs.sendMessage(9, "Hello World!", (num: number) => alert(num + 1)); -} - function testTabsSendRequest() { chrome.tabs.sendRequest(1, "Hello World!"); chrome.tabs.sendRequest(2, "Hello World!", console.log); @@ -1935,8 +2518,8 @@ function testContextMenusCreate() { } function testContextMenusRemove() { - chrome.contextMenus.remove(1); - chrome.contextMenus.remove(1, () => console.log("removed")); + chrome.contextMenus.remove(1); // $ExpectType Promise + chrome.contextMenus.remove(1, () => console.log("removed")); // $ExpectType void // @ts-expect-error chrome.contextMenus.remove(1, (invalid: any) => console.log("removed")); chrome.contextMenus.remove("dummy-id"); @@ -1947,15 +2530,15 @@ function testContextMenusRemove() { } function testContextMenusRemoveAll() { - chrome.contextMenus.removeAll(); - chrome.contextMenus.removeAll(() => console.log("removed all")); + chrome.contextMenus.removeAll(); // $ExpectType Promise + chrome.contextMenus.removeAll(() => console.log("removed all")); // $ExpectType void // @ts-expect-error chrome.contextMenus.removeAll((invalid: any) => console.log("removed")); } function testContextMenusUpdate() { - chrome.contextMenus.update(1, { title: "Hello World!" }); - chrome.contextMenus.update(1, { title: "Hello World!" }, () => console.log("updated")); + chrome.contextMenus.update(1, { title: "Hello World!" }); // $ExpectType Promise + chrome.contextMenus.update(1, { title: "Hello World!" }, () => console.log("updated")); // $ExpectType void chrome.contextMenus.update(Math.random() > 0.5 ? "1" : 1, { title: "Hello World!" }, () => console.log("updated")); // @ts-expect-error chrome.contextMenus.update(1, { title: "Hello World!" }, (invalid: any) => console.log("updated")); @@ -2027,37 +2610,70 @@ function testContextMenusUpdate() { chrome.contextMenus.update(1, { visible: 1 }); } +// https://developer.chrome.com/docs/extensions/reference/api/permissions function testPermissions() { const permissions: chrome.permissions.Permissions = { + permissions: ["tabs"], origins: ["https://example.com/*"], }; - chrome.permissions.contains(permissions, (exists: boolean) => {}); - chrome.permissions.remove(permissions, (wasRemoved: boolean) => {}); - chrome.permissions.request(permissions, (wasAdded: boolean) => {}); - chrome.permissions.getAll((permissions: chrome.permissions.Permissions) => {}); -} -async function testPermissionsForPromise() { - const permissions: chrome.permissions.Permissions = { - origins: ["https://example.com/*"], - }; - if (await chrome.permissions.contains(permissions)) { - let wasRemoved: boolean = await chrome.permissions.remove(permissions); - } else { - let wasAdded: boolean = await chrome.permissions.request(permissions); - } + chrome.permissions.contains(permissions); // $ExpectType Promise + chrome.permissions.contains(permissions, (result: boolean) => {}); // $ExpectType void + // @ts-expect-error + chrome.permissions.contains(permissions, () => {}).then(() => {}); + // @ts-expect-error : 'test' is not a recognized permission. + chrome.permissions.contains({ permissions: ["test"] }); - const existing: chrome.permissions.Permissions = await chrome.permissions.getAll(); -} + chrome.permissions.getAll(); // $ExpectType Promise + chrome.permissions.getAll((permissions: chrome.permissions.Permissions) => {}); // $ExpectType void + // @ts-expect-error + chrome.permissions.getAll(() => {}).then(() => {}); -// https://developer.chrome.com/docs/extensions/reference/enterprise_deviceAttributes -function testEnterpriseDeviceAttributes() { - chrome.enterprise.deviceAttributes.getDirectoryDeviceId((deviceId) => {}); - chrome.enterprise.deviceAttributes.getDeviceSerialNumber((serialNumber) => {}); - chrome.enterprise.deviceAttributes.getDeviceAssetId((assetId) => {}); - chrome.enterprise.deviceAttributes.getDeviceAnnotatedLocation((annotatedLocation) => {}); - chrome.enterprise.deviceAttributes.getDeviceHostname((hostName) => {}); -} + chrome.permissions.request(permissions); // $ExpectType Promise + chrome.permissions.request(permissions, (granted: boolean) => {}); // $ExpectType void + // @ts-expect-error + chrome.permissions.request(permissions, () => {}).then(() => {}); + // @ts-expect-error : 'test' is not a recognized permission. + chrome.permissions.request({ permissions: ["test"] }); + + chrome.permissions.remove(permissions); // $ExpectType Promise + chrome.permissions.remove(permissions, (removed: boolean) => {}); // $ExpectType void + // @ts-expect-error + chrome.permissions.remove(permissions, () => {}).then(() => {}); + // @ts-expect-error : 'test' is not a recognized permission. + chrome.permissions.remove({ permissions: ["test"] }); + + chrome.permissions.onAdded.addListener((permissions) => { + permissions; // $ExpectType Permissions + }); + chrome.permissions.onAdded.removeListener((permissions) => { + permissions; // $ExpectType Permissions + }); + chrome.permissions.onAdded.hasListener((permissions) => { + permissions; // $ExpectType Permissions + }); + chrome.permissions.onAdded.hasListeners(); // $ExpectType boolean + + chrome.permissions.onRemoved.addListener((permissions) => { + permissions; // $ExpectType Permissions + }); + chrome.permissions.onRemoved.removeListener((permissions) => { + permissions; // $ExpectType Permissions + }); + chrome.permissions.onRemoved.hasListener((permissions) => { + permissions; // $ExpectType Permissions + }); + chrome.permissions.onRemoved.hasListeners(); // $ExpectType boolean +} + +// https://developer.chrome.com/docs/extensions/reference/enterprise_deviceAttributes +function testEnterpriseDeviceAttributes() { + chrome.enterprise.deviceAttributes.getDirectoryDeviceId((deviceId) => {}); + chrome.enterprise.deviceAttributes.getDeviceSerialNumber((serialNumber) => {}); + chrome.enterprise.deviceAttributes.getDeviceAssetId((assetId) => {}); + chrome.enterprise.deviceAttributes.getDeviceAnnotatedLocation((annotatedLocation) => {}); + chrome.enterprise.deviceAttributes.getDeviceHostname((hostName) => {}); +} // https://developer.chrome.com/docs/extensions/reference/api/enterprise/hardwarePlatform function testEnterpriseHardwarePlatform() { @@ -2524,7 +3140,7 @@ function testUserScripts() { chrome.userScripts.getScripts(userScriptFilter); // $ExpectType Promise chrome.userScripts.getScripts(userScriptFilter, (scripts: chrome.userScripts.RegisteredUserScript[]) => void 0); // $ExpectType void - const scripts: chrome.userScripts.RegisteredUserScript[] = [ + const scripts = [ { id: "scriptId1", js: [{ code: "console.log(\"Hello from scriptId1!\");" }], @@ -2536,18 +3152,32 @@ function testUserScripts() { matches: ["*://example.org/*"], }, ]; + + const badScripts = [ + { + id: "badScriptId", + matches: ["*://example.com/*"], + }, + ]; + chrome.userScripts.register(scripts); // $ExpectType Promise chrome.userScripts.register(scripts, () => void 0); // $ExpectType void + // @ts-expect-error Missing required property 'js'. + chrome.userScripts.register(badScripts); chrome.userScripts.unregister(userScriptFilter); // $ExpectType Promise chrome.userScripts.unregister(userScriptFilter, () => void 0); // $ExpectType void chrome.userScripts.update(scripts); // $ExpectType Promise chrome.userScripts.update(scripts, () => void 0); // $ExpectType void + // @ts-expect-error Missing required property 'js'. + chrome.userScripts.update(badScripts); } // https://developer.chrome.com/docs/extensions/reference/api/enterprise/platformKeys function testEnterPrisePlatformKeys() { + const tokenId = "tokenId"; + chrome.enterprise.platformKeys.Scope.MACHINE === "MACHINE"; chrome.enterprise.platformKeys.Scope.USER === "USER"; @@ -2560,18 +3190,47 @@ function testEnterPrisePlatformKeys() { registerKey: { algorithm: "ECDSA" }, }, () => {}); - chrome.enterprise.platformKeys.challengeMachineKey(new ArrayBuffer(0), true, response => {}); // $ExpectType void - chrome.enterprise.platformKeys.challengeMachineKey(new ArrayBuffer(0), response => {}); // $ExpectType void + chrome.enterprise.platformKeys.challengeMachineKey(new ArrayBuffer(0)); // $ExpectType Promise + chrome.enterprise.platformKeys.challengeMachineKey(new ArrayBuffer(0), true); // $ExpectType Promise + chrome.enterprise.platformKeys.challengeMachineKey(new ArrayBuffer(0), response => { // $ExpectType void + response; // $ExpectType ArrayBuffer + }); + chrome.enterprise.platformKeys.challengeMachineKey(new ArrayBuffer(0), true, response => { // $ExpectType void + response; // $ExpectType ArrayBuffer + }); + // @ts-expect-error + chrome.enterprise.platformKeys.challengeMachineKey(new ArrayBuffer(0), () => {}).then(() => {}); - chrome.enterprise.platformKeys.challengeUserKey(new ArrayBuffer(0), true, response => {}); // $ExpectType void + chrome.enterprise.platformKeys.challengeUserKey(new ArrayBuffer(0), true); // $ExpectType Promise + chrome.enterprise.platformKeys.challengeUserKey(new ArrayBuffer(0), true, response => { // $ExpectType void + response; // $ExpectType ArrayBuffer + }); + // @ts-expect-error + chrome.enterprise.platformKeys.challengeUserKey(new ArrayBuffer(0), true, () => {}).then(() => {}); - chrome.enterprise.platformKeys.getCertificates("tokenId", certificates => {}); // $ExpectType void + chrome.enterprise.platformKeys.getCertificates(tokenId); // $ExpectType Promise + chrome.enterprise.platformKeys.getCertificates(tokenId, certificates => { // $ExpectType void + certificates; // $ExpectType ArrayBuffer[] + }); + // @ts-expect-error + chrome.enterprise.platformKeys.getCertificates(tokenId, () => {}).then(() => {}); - chrome.enterprise.platformKeys.getTokens(tokens => {}); // $ExpectType void + chrome.enterprise.platformKeys.getTokens(); // $ExpectType Promise + chrome.enterprise.platformKeys.getTokens(tokens => { // $ExpectType void + tokens; // $ExpectType Token[] + }); + // @ts-expect-error + chrome.enterprise.platformKeys.getTokens(() => {}).then(() => {}); - chrome.enterprise.platformKeys.importCertificate("tokenId", new ArrayBuffer(0), () => {}); // $ExpectType void + chrome.enterprise.platformKeys.importCertificate(tokenId, new ArrayBuffer(0)); // $ExpectType Promise + chrome.enterprise.platformKeys.importCertificate(tokenId, new ArrayBuffer(0), () => {}); // $ExpectType void + // @ts-expect-error + chrome.enterprise.platformKeys.importCertificate(tokenId, new ArrayBuffer(0), () => {}).then(() => {}); - chrome.enterprise.platformKeys.removeCertificate("tokenId", new ArrayBuffer(0), () => {}); // $ExpectType void + chrome.enterprise.platformKeys.removeCertificate(tokenId, new ArrayBuffer(0)); // $ExpectType Promise + chrome.enterprise.platformKeys.removeCertificate(tokenId, new ArrayBuffer(0), () => {}); // $ExpectType void + // @ts-expect-error + chrome.enterprise.platformKeys.removeCertificate(tokenId, new ArrayBuffer(0), () => {}).then(() => {}); } // https://developer.chrome.com/docs/extensions/reference/api/power @@ -2699,3 +3358,1399 @@ function testPrintingMetrics() { }); chrome.printingMetrics.onPrintJobFinished.hasListeners(); } + +// https://developer.chrome.com/docs/extensions/reference/api/webRequest +function testWebRequest() { + const filter: chrome.webRequest.RequestFilter = { + tabId: 1, + urls: ["https://example.com/*"], + types: ["main_frame"], + windowId: 2, + }; + const extraInfoSpec = ["extraHeaders"]; + + const blockingResponse = { + cancel: true, + redirectUrl: "https://example.com", + requestHeaders: [{ name: "name", value: "value" }], + }; + + chrome.webRequest.MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES === 20; + + chrome.webRequest.handlerBehaviorChanged(() => {}); // $ExpectType void + chrome.webRequest.handlerBehaviorChanged(); // $ExpectType Promise + // @ts-expect-error + chrome.webRequest.handlerBehaviorChanged(() => {}).then(() => {}); + + chrome.webRequest.onAuthRequired.addListener( + ({ frameId }, asyncCallback) => { + frameId; // $ExpectType number + if (!asyncCallback) return; + asyncCallback(blockingResponse); // $ExpectType void + }, + filter, + extraInfoSpec, + ); + chrome.webRequest.onAuthRequired.removeListener(({ frameId }, asyncCallback) => { + frameId; // $ExpectType number + if (!asyncCallback) return; + asyncCallback(blockingResponse); // $ExpectType void + }); + chrome.webRequest.onAuthRequired.hasListener(({ frameId }, asyncCallback) => { + frameId; // $ExpectType number + if (!asyncCallback) return; + asyncCallback(blockingResponse); // $ExpectType void + }); + chrome.webRequest.onAuthRequired.hasListeners(); + + chrome.webRequest.onBeforeRedirect.addListener( + ({ frameId }) => { + frameId; // $ExpectType number + }, + filter, + extraInfoSpec, + ); + chrome.webRequest.onBeforeRedirect.removeListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onBeforeRedirect.hasListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onBeforeRedirect.hasListeners(); + + chrome.webRequest.onBeforeRequest.addListener( + ({ frameId }) => { + frameId; // $ExpectType number + }, + filter, + extraInfoSpec, + ); + chrome.webRequest.onBeforeRequest.removeListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onBeforeRequest.hasListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onBeforeRequest.hasListeners(); + + chrome.webRequest.onBeforeSendHeaders.addListener( + (details) => { + details; // $ExpectType WebRequestHeadersDetails + }, + filter, + extraInfoSpec, + ); + chrome.webRequest.onBeforeSendHeaders.removeListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onBeforeSendHeaders.hasListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onBeforeSendHeaders.hasListeners(); + + chrome.webRequest.onCompleted.addListener( + (details) => { + details; // $ExpectType WebResponseCacheDetails + }, + filter, + extraInfoSpec, + ); + chrome.webRequest.onCompleted.removeListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onCompleted.hasListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onCompleted.hasListeners(); + + chrome.webRequest.onErrorOccurred.addListener( + (details) => { + details; // $ExpectType WebResponseErrorDetails + }, + filter, + extraInfoSpec, + ); + chrome.webRequest.onErrorOccurred.removeListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onErrorOccurred.hasListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onErrorOccurred.hasListeners(); + + chrome.webRequest.onHeadersReceived.addListener( + (details) => { + details; // $ExpectType WebResponseHeadersDetails + }, + filter, + extraInfoSpec, + ); + chrome.webRequest.onHeadersReceived.removeListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onHeadersReceived.hasListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onHeadersReceived.hasListeners(); + + chrome.webRequest.onResponseStarted.addListener( + (details) => { + details; // $ExpectType WebResponseCacheDetails + }, + filter, + extraInfoSpec, + ); + chrome.webRequest.onResponseStarted.removeListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onResponseStarted.hasListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onResponseStarted.hasListeners(); + + chrome.webRequest.onSendHeaders.addListener( + (details) => { + details; // $ExpectType WebRequestHeadersDetails + }, + filter, + extraInfoSpec, + ); + chrome.webRequest.onSendHeaders.removeListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onSendHeaders.hasListener(({ frameId }) => { + frameId; // $ExpectType number + }); + chrome.webRequest.onSendHeaders.hasListeners(); +} + +// https://developer.chrome.com/docs/extensions/reference/api/accessibilityFeatures +function testAccessibilityFeatures() { + // animationPolicy + chrome.accessibilityFeatures.animationPolicy.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.animationPolicy.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult<"allowed" | "once" | "none"> + }); + // @ts-expect-error + chrome.accessibilityFeatures.animationPolicy.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.animationPolicy.set({ value: "allowed", scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.animationPolicy.set({ value: "allowed", scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.animationPolicy.set({ value: "allowed", scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.animationPolicy.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.animationPolicy.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.animationPolicy.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.animationPolicy.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails<"allowed" | "once" | "none"> + }); + chrome.accessibilityFeatures.animationPolicy.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails<"allowed" | "once" | "none"> + }); + chrome.accessibilityFeatures.animationPolicy.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails<"allowed" | "once" | "none"> + }); + chrome.accessibilityFeatures.animationPolicy.onChange.hasListeners(); // $ExpectType boolean + + // autoclick + chrome.accessibilityFeatures.autoclick.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.autoclick.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.autoclick.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.autoclick.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.autoclick.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.autoclick.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.autoclick.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.autoclick.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.autoclick.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.autoclick.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.autoclick.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.autoclick.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.autoclick.onChange.hasListeners(); // $ExpectType boolean + + // caretHighlight + chrome.accessibilityFeatures.caretHighlight.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.caretHighlight.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.caretHighlight.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.caretHighlight.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.caretHighlight.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.caretHighlight.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.caretHighlight.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.caretHighlight.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.caretHighlight.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.caretHighlight.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.caretHighlight.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.caretHighlight.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.caretHighlight.onChange.hasListeners(); // $ExpectType boolean + + // cursorColor + chrome.accessibilityFeatures.cursorColor.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.cursorColor.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.cursorColor.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.cursorColor.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.cursorColor.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.cursorColor.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.cursorColor.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.cursorColor.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.cursorColor.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.cursorColor.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.cursorColor.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.cursorColor.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.cursorColor.onChange.hasListeners(); // $ExpectType boolean + + // cursorHighlight + chrome.accessibilityFeatures.cursorHighlight.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.cursorHighlight.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + + // @ts-expect-error + chrome.accessibilityFeatures.cursorHighlight.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.cursorHighlight.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.cursorHighlight.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.cursorHighlight.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.cursorHighlight.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.cursorHighlight.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.cursorHighlight.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.cursorHighlight.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.cursorHighlight.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.cursorHighlight.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.cursorHighlight.onChange.hasListeners(); // $ExpectType boolean + + // dictation + chrome.accessibilityFeatures.dictation.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.dictation.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + + // @ts-expect-error + chrome.accessibilityFeatures.dictation.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.dictation.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.dictation.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.dictation.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.dictation.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.dictation.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.dictation.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.dictation.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.dictation.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.dictation.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.dictation.onChange.hasListeners(); // $ExpectType boolean + + // dockedMagnifier + chrome.accessibilityFeatures.dockedMagnifier.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.dockedMagnifier.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + + // @ts-expect-error + chrome.accessibilityFeatures.dockedMagnifier.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.dockedMagnifier.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.dockedMagnifier.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.dockedMagnifier.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.dockedMagnifier.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.dockedMagnifier.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.dockedMagnifier.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.dockedMagnifier.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.dockedMagnifier.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.dockedMagnifier.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.dockedMagnifier.onChange.hasListeners(); // $ExpectType boolean + + // focusHighlight + chrome.accessibilityFeatures.focusHighlight.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.focusHighlight.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.focusHighlight.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.focusHighlight.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.focusHighlight.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.focusHighlight.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.focusHighlight.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.focusHighlight.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.focusHighlight.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.focusHighlight.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.focusHighlight.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.focusHighlight.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.focusHighlight.onChange.hasListeners(); // $ExpectType boolean + + // highContrast + chrome.accessibilityFeatures.highContrast.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.highContrast.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.highContrast.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.highContrast.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.highContrast.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.highContrast.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.highContrast.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.highContrast.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.highContrast.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.highContrast.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.highContrast.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.highContrast.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.highContrast.onChange.hasListeners(); // $ExpectType boolean + + // largeCursor + chrome.accessibilityFeatures.largeCursor.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.largeCursor.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.largeCursor.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.largeCursor.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.largeCursor.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.largeCursor.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.largeCursor.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.largeCursor.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.largeCursor.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.largeCursor.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.largeCursor.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.largeCursor.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.largeCursor.onChange.hasListeners(); // $ExpectType boolean + + // screenMagnifier + chrome.accessibilityFeatures.screenMagnifier.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.screenMagnifier.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.screenMagnifier.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.screenMagnifier.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.screenMagnifier.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.screenMagnifier.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.screenMagnifier.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.screenMagnifier.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.screenMagnifier.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.screenMagnifier.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.screenMagnifier.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.screenMagnifier.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.screenMagnifier.onChange.hasListeners(); // $ExpectType boolean + + // selectToSpeak + chrome.accessibilityFeatures.selectToSpeak.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.selectToSpeak.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.selectToSpeak.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.selectToSpeak.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.selectToSpeak.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.selectToSpeak.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.selectToSpeak.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.selectToSpeak.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.selectToSpeak.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.selectToSpeak.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.selectToSpeak.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.selectToSpeak.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.selectToSpeak.onChange.hasListeners(); // $ExpectType boolean + + // spokenFeedback + chrome.accessibilityFeatures.spokenFeedback.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.spokenFeedback.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.spokenFeedback.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.spokenFeedback.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.spokenFeedback.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.spokenFeedback.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.spokenFeedback.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.spokenFeedback.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.spokenFeedback.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.spokenFeedback.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.spokenFeedback.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.spokenFeedback.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.spokenFeedback.onChange.hasListeners(); // $ExpectType boolean + + // stickyKeys + chrome.accessibilityFeatures.stickyKeys.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.stickyKeys.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.stickyKeys.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.stickyKeys.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.stickyKeys.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.stickyKeys.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.stickyKeys.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.stickyKeys.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.stickyKeys.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.stickyKeys.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.stickyKeys.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.stickyKeys.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.stickyKeys.onChange.hasListeners(); // $ExpectType boolean + + // switchAccess + chrome.accessibilityFeatures.switchAccess.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.switchAccess.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.switchAccess.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.switchAccess.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.switchAccess.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.switchAccess.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.switchAccess.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.switchAccess.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.switchAccess.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.switchAccess.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.switchAccess.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.switchAccess.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.switchAccess.onChange.hasListeners(); // $ExpectType boolean + + // virtualKeyboard + chrome.accessibilityFeatures.virtualKeyboard.get({ incognito: false }); // $ExpectType Promise> + chrome.accessibilityFeatures.virtualKeyboard.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.accessibilityFeatures.virtualKeyboard.get({}, () => {}).then(() => {}); + + chrome.accessibilityFeatures.virtualKeyboard.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.virtualKeyboard.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.virtualKeyboard.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.virtualKeyboard.clear({ scope: "regular" }); // $ExpectType Promise + chrome.accessibilityFeatures.virtualKeyboard.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.accessibilityFeatures.virtualKeyboard.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.accessibilityFeatures.virtualKeyboard.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.virtualKeyboard.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.virtualKeyboard.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.accessibilityFeatures.virtualKeyboard.onChange.hasListeners(); // $ExpectType boolean +} + +// https://developer.chrome.com/docs/extensions/reference/api/privacy +function testPrivacy() { + chrome.privacy.IPHandlingPolicy.DEFAULT === "default"; + chrome.privacy.IPHandlingPolicy.DEFAULT_PUBLIC_AND_PRIVATE_INTERFACES === "default_public_and_private_interfaces"; + chrome.privacy.IPHandlingPolicy.DEFAULT_PUBLIC_INTERFACE_ONLY === "default_public_interface_only"; + chrome.privacy.IPHandlingPolicy.DISABLE_NON_PROXIED_UDP === "disable_non_proxied_udp"; + + // virtualKeyboard + chrome.privacy.services.alternateErrorPagesEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.alternateErrorPagesEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.alternateErrorPagesEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.alternateErrorPagesEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.alternateErrorPagesEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.alternateErrorPagesEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.alternateErrorPagesEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.alternateErrorPagesEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.alternateErrorPagesEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.alternateErrorPagesEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.alternateErrorPagesEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.alternateErrorPagesEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.alternateErrorPagesEnabled.onChange.hasListeners(); // $ExpectType boolean + + // autofillAddressEnabled + chrome.privacy.services.autofillAddressEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.autofillAddressEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.autofillAddressEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.autofillAddressEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.autofillAddressEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.autofillAddressEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.autofillAddressEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.autofillAddressEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.autofillAddressEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.autofillAddressEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.autofillAddressEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.autofillAddressEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.autofillAddressEnabled.onChange.hasListeners(); // $ExpectType boolean + + // autofillCreditCardEnabled + chrome.privacy.services.autofillCreditCardEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.autofillCreditCardEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.autofillCreditCardEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.autofillCreditCardEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.autofillCreditCardEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.autofillCreditCardEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.autofillCreditCardEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.autofillCreditCardEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.autofillCreditCardEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.autofillCreditCardEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.autofillCreditCardEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.autofillCreditCardEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.autofillCreditCardEnabled.onChange.hasListeners(); // $ExpectType boolean + + // autofillEnabled + chrome.privacy.services.autofillEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.autofillEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.autofillEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.autofillEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.autofillEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.autofillEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.autofillEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.autofillEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.autofillEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.autofillEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.autofillEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.autofillEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.autofillEnabled.onChange.hasListeners(); // $ExpectType boolean + + // passwordSavingEnabled + chrome.privacy.services.passwordSavingEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.passwordSavingEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.passwordSavingEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.passwordSavingEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.passwordSavingEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.passwordSavingEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.passwordSavingEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.passwordSavingEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.passwordSavingEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.passwordSavingEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.passwordSavingEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.passwordSavingEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.passwordSavingEnabled.onChange.hasListeners(); // $ExpectType boolean + + // safeBrowsingEnabled + chrome.privacy.services.safeBrowsingEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.safeBrowsingEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.safeBrowsingEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.safeBrowsingEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.safeBrowsingEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.safeBrowsingEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.safeBrowsingEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.safeBrowsingEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.safeBrowsingEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.safeBrowsingEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.safeBrowsingEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.safeBrowsingEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.safeBrowsingEnabled.onChange.hasListeners(); // $ExpectType boolean + + // safeBrowsingExtendedReportingEnabled + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.set({ value: true, scope: "regular" }, () => {}).then( + () => {}, + ); + + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.safeBrowsingExtendedReportingEnabled.onChange.hasListeners(); // $ExpectType boolean + + // searchSuggestEnabled + chrome.privacy.services.searchSuggestEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.searchSuggestEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.searchSuggestEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.searchSuggestEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.searchSuggestEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.searchSuggestEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.searchSuggestEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.searchSuggestEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.searchSuggestEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.searchSuggestEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.searchSuggestEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.searchSuggestEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.searchSuggestEnabled.onChange.hasListeners(); // $ExpectType boolean + + // spellingServiceEnabled + chrome.privacy.services.spellingServiceEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.spellingServiceEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.spellingServiceEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.spellingServiceEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.spellingServiceEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.spellingServiceEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.spellingServiceEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.spellingServiceEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.spellingServiceEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.spellingServiceEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.spellingServiceEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.spellingServiceEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.spellingServiceEnabled.onChange.hasListeners(); // $ExpectType boolean + + // translationServiceEnabled + chrome.privacy.services.translationServiceEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.services.translationServiceEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.services.translationServiceEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.services.translationServiceEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.translationServiceEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.translationServiceEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.translationServiceEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.services.translationServiceEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.services.translationServiceEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.services.translationServiceEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.translationServiceEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.translationServiceEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.services.translationServiceEnabled.onChange.hasListeners(); // $ExpectType boolean + + // networkPredictionEnabled + chrome.privacy.network.networkPredictionEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.network.networkPredictionEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.network.networkPredictionEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.network.networkPredictionEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.network.networkPredictionEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.network.networkPredictionEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.network.networkPredictionEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.network.networkPredictionEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.network.networkPredictionEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.network.networkPredictionEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.network.networkPredictionEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.network.networkPredictionEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.network.networkPredictionEnabled.onChange.hasListeners(); // $ExpectType boolean + + // webRTCIPHandlingPolicy + chrome.privacy.network.webRTCIPHandlingPolicy.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.network.webRTCIPHandlingPolicy.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult<"default" | "default_public_and_private_interfaces" | "default_public_interface_only" | "disable_non_proxied_udp"> + }); + // @ts-expect-error + chrome.privacy.network.webRTCIPHandlingPolicy.get({}, () => {}).then(() => {}); + + chrome.privacy.network.webRTCIPHandlingPolicy.set({ // $ExpectType Promise + value: chrome.privacy.IPHandlingPolicy.DEFAULT, + scope: "regular", + }); + chrome.privacy.network.webRTCIPHandlingPolicy.set({ value: "default", scope: "regular" }); // $ExpectType Promise + chrome.privacy.network.webRTCIPHandlingPolicy.set({ value: "default", scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.network.webRTCIPHandlingPolicy.set({ value: "default", scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.network.webRTCIPHandlingPolicy.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.network.webRTCIPHandlingPolicy.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.network.webRTCIPHandlingPolicy.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.network.webRTCIPHandlingPolicy.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails<"default" | "default_public_and_private_interfaces" | "default_public_interface_only" | "disable_non_proxied_udp"> + }); + chrome.privacy.network.webRTCIPHandlingPolicy.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails<"default" | "default_public_and_private_interfaces" | "default_public_interface_only" | "disable_non_proxied_udp"> + }); + chrome.privacy.network.webRTCIPHandlingPolicy.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails<"default" | "default_public_and_private_interfaces" | "default_public_interface_only" | "disable_non_proxied_udp"> + }); + chrome.privacy.network.webRTCIPHandlingPolicy.onChange.hasListeners(); // $ExpectType boolean + + // adMeasurementEnabled + chrome.privacy.websites.adMeasurementEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.websites.adMeasurementEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.websites.adMeasurementEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.websites.adMeasurementEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.adMeasurementEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.adMeasurementEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.adMeasurementEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.adMeasurementEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.adMeasurementEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.adMeasurementEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.adMeasurementEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.adMeasurementEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.adMeasurementEnabled.onChange.hasListeners(); // $ExpectType boolean + + // doNotTrackEnabled + chrome.privacy.websites.doNotTrackEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.websites.doNotTrackEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.websites.doNotTrackEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.websites.doNotTrackEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.doNotTrackEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.doNotTrackEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.doNotTrackEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.doNotTrackEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.doNotTrackEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.doNotTrackEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.doNotTrackEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.doNotTrackEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.doNotTrackEnabled.onChange.hasListeners(); // $ExpectType boolean + + // fledgeEnabled + chrome.privacy.websites.fledgeEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.websites.fledgeEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.websites.fledgeEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.websites.fledgeEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.fledgeEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.fledgeEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.fledgeEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.fledgeEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.fledgeEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.fledgeEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.fledgeEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.fledgeEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.fledgeEnabled.onChange.hasListeners(); // $ExpectType boolean + + // hyperlinkAuditingEnabled + chrome.privacy.websites.hyperlinkAuditingEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.websites.hyperlinkAuditingEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.websites.hyperlinkAuditingEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.websites.hyperlinkAuditingEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.hyperlinkAuditingEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.hyperlinkAuditingEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.hyperlinkAuditingEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.hyperlinkAuditingEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.hyperlinkAuditingEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.hyperlinkAuditingEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.hyperlinkAuditingEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.hyperlinkAuditingEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.hyperlinkAuditingEnabled.onChange.hasListeners(); // $ExpectType boolean + + // protectedContentEnabled + chrome.privacy.websites.protectedContentEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.websites.protectedContentEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.websites.protectedContentEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.websites.protectedContentEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.protectedContentEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.protectedContentEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.protectedContentEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.protectedContentEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.protectedContentEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.protectedContentEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.protectedContentEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.protectedContentEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.protectedContentEnabled.onChange.hasListeners(); // $ExpectType boolean + + // referrersEnabled + chrome.privacy.websites.referrersEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.websites.referrersEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.websites.referrersEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.websites.referrersEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.referrersEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.referrersEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.referrersEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.referrersEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.referrersEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.referrersEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.referrersEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.referrersEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.referrersEnabled.onChange.hasListeners(); // $ExpectType boolean + + // relatedWebsiteSetsEnabled + chrome.privacy.websites.relatedWebsiteSetsEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.websites.relatedWebsiteSetsEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.websites.relatedWebsiteSetsEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.websites.relatedWebsiteSetsEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.relatedWebsiteSetsEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.relatedWebsiteSetsEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.relatedWebsiteSetsEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.relatedWebsiteSetsEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.relatedWebsiteSetsEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.relatedWebsiteSetsEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.relatedWebsiteSetsEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.relatedWebsiteSetsEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.relatedWebsiteSetsEnabled.onChange.hasListeners(); // $ExpectType boolean + + // thirdPartyCookiesAllowed + chrome.privacy.websites.thirdPartyCookiesAllowed.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.websites.thirdPartyCookiesAllowed.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.websites.thirdPartyCookiesAllowed.get({}, () => {}).then(() => {}); + + chrome.privacy.websites.thirdPartyCookiesAllowed.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.thirdPartyCookiesAllowed.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.thirdPartyCookiesAllowed.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.thirdPartyCookiesAllowed.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.thirdPartyCookiesAllowed.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.thirdPartyCookiesAllowed.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.thirdPartyCookiesAllowed.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.thirdPartyCookiesAllowed.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.thirdPartyCookiesAllowed.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.thirdPartyCookiesAllowed.onChange.hasListeners(); // $ExpectType boolean + + // topicsEnabled + chrome.privacy.websites.topicsEnabled.get({ incognito: false }); // $ExpectType Promise> + chrome.privacy.websites.topicsEnabled.get({ incognito: false }, (details) => { // $ExpectType void + details; // $ExpectType ChromeSettingGetResult + }); + // @ts-expect-error + chrome.privacy.websites.topicsEnabled.get({}, () => {}).then(() => {}); + + chrome.privacy.websites.topicsEnabled.set({ value: true, scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.topicsEnabled.set({ value: true, scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.topicsEnabled.set({ value: true, scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.topicsEnabled.clear({ scope: "regular" }); // $ExpectType Promise + chrome.privacy.websites.topicsEnabled.clear({ scope: "regular" }, () => {}); // $ExpectType void + // @ts-expect-error + chrome.privacy.websites.topicsEnabled.clear({ scope: "regular" }, () => {}).then(() => {}); + + chrome.privacy.websites.topicsEnabled.onChange.addListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.topicsEnabled.onChange.removeListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.topicsEnabled.onChange.hasListener(details => { + details; // $ExpectType ChromeSettingOnChangeDetails + }); + chrome.privacy.websites.topicsEnabled.onChange.hasListeners(); // $ExpectType boolean +} + +// https://developer.chrome.com/docs/extensions/reference/api/readingList +function testReadingList() { + const { + addEntry, + query, + removeEntry, + updateEntry, + onEntryAdded, + onEntryRemoved, + onEntryUpdated, + } = chrome.readingList; + + const testAddEntry = () => { + const entry = { + hasBeenRead: true, + title: "title", + url: "url", + }; + + // @ts-expect-error + addEntry(); + + // @ts-expect-error + addEntry({}); + addEntry(entry); // $ExpectType Promise + + // @ts-expect-error + addEntry({}, () => {}); + addEntry(entry, () => {}); // $ExpectType void + + // @ts-expect-error + addEntry(entry, () => {}).then(() => {}); + }; + + const testQuery = () => { + const info = { + hasBeenRead: true, + title: "title", + url: "url", + }; + + // @ts-expect-error + query(); + + query({}); // $ExpectType Promise + query(info); // $ExpectType Promise + + query({}, () => {}); // $ExpectType void + query(info, () => {}); // $ExpectType void + + // @ts-expect-error + query(info, () => {}).then(() => {}); + }; + + const testRemoveEntry = () => { + const info = { + url: "url", + }; + + // @ts-expect-error + removeEntry(); + + // @ts-expect-error + removeEntry({}); + removeEntry(info); // $ExpectType Promise + + // @ts-expect-error + removeEntry({}, () => {}); + removeEntry(info, () => {}); // $ExpectType void + + // @ts-expect-error + removeEntry(info, () => {}).then(() => {}); + }; + + const testUpdateEntry = () => { + const info = { + hasBeenRead: true, + title: "title", + url: "url", + }; + + // @ts-expect-error + updateEntry(); + + // @ts-expect-error + updateEntry({}); + updateEntry({ url: "url" }); // $ExpectType Promise + updateEntry(info); // $ExpectType Promise + + // @ts-expect-error + updateEntry({}, () => {}); + updateEntry({ url: "url" }, () => {}); // $ExpectType void + updateEntry(info, () => {}); // $ExpectType void + + // @ts-expect-error + updateEntry(info, () => {}).then(() => {}); + }; + + const testOnEntryAdded = () => { + onEntryAdded.addListener((entry) => { + entry; // $ExpectType ReadingListEntry + }); + onEntryAdded.removeListener((entry) => { + entry; // $ExpectType ReadingListEntry + }); + onEntryAdded.hasListener((entry) => { + entry; // $ExpectType ReadingListEntry + }); + onEntryAdded.hasListeners(); // $ExpectType boolean + }; + + const testOnEntryRemoved = () => { + onEntryRemoved.addListener((entry) => { + entry; // $ExpectType ReadingListEntry + }); + onEntryRemoved.removeListener((entry) => { + entry; // $ExpectType ReadingListEntry + }); + onEntryRemoved.hasListener((entry) => { + entry; // $ExpectType ReadingListEntry + }); + onEntryRemoved.hasListeners(); // $ExpectType boolean + }; + + const testOnEntryUpdated = () => { + onEntryUpdated.addListener((entry) => { + entry; // $ExpectType ReadingListEntry + }); + onEntryUpdated.removeListener((entry) => { + entry; // $ExpectType ReadingListEntry + }); + onEntryUpdated.hasListener((entry) => { + entry; // $ExpectType ReadingListEntry + }); + onEntryUpdated.hasListeners(); // $ExpectType boolean + }; +} diff --git a/types/chromecast-caf-receiver/cast.framework.d.ts b/types/chromecast-caf-receiver/cast.framework.d.ts index 808974fb1216a3d..a50a83ec7dd5af9 100644 --- a/types/chromecast-caf-receiver/cast.framework.d.ts +++ b/types/chromecast-caf-receiver/cast.framework.d.ts @@ -96,7 +96,7 @@ export class TextTracksManager { * Sets text tracks to be active by id. * @throws Error If id is invalid. */ - setActiveByIds(newIds: number[]): void; + setActiveByIds(newIds: number[] | null): void; /** * Sets text tracks to be active by language. diff --git a/types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts b/types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts index d9318a8a9ae1c38..70ac60f31c55c35 100644 --- a/types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts +++ b/types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts @@ -51,6 +51,9 @@ pManager.addEventListener( ); const ttManager = new cast.framework.TextTracksManager(); +ttManager.setActiveByIds(null); +ttManager.setActiveByIds([2, 3]); + const qManager = new cast.framework.QueueManager(); const qBase = new cast.framework.QueueBase(); const items = qBase.fetchItems(1, 3, 4); diff --git a/types/clevertap/clevertap-tests.ts b/types/clevertap/clevertap-tests.ts index 979ed9ead5d367f..2ee3daeff956c15 100644 --- a/types/clevertap/clevertap-tests.ts +++ b/types/clevertap/clevertap-tests.ts @@ -157,3 +157,21 @@ clevertap.targets(clevertap.TARGET_RESULT, resultPayload, { debug: 1 }, (res: an // or if you prefer Promises clevertap.targets(clevertap.TARGET_RESULT, resultPayload, { debug: 1 }).then((res: any) => {}); + +// List all Message Reports in a date range +const MessageReportPayload = { from: "20210101", to: "20210201" }; + +// callback style +clevertap.getMessageReports(MessageReportPayload, { debug: 1 }, (res: any) => {}); + +// or if you prefer Promises +clevertap.getMessageReports(MessageReportPayload, { debug: 1 }).then((res: any) => {}); + +// When the dates are incorrectly inputed as integers +const ErroneousMessageReportPayload = { from: 20210101, to: 20210201 }; +// callback style +// @ts-expect-error +clevertap.getMessageReports(ErroneousMessageReportPayload, { debug: 1 }, (res: any) => {}); +// or if you prefer Promises +// @ts-expect-error +clevertap.getMessageReports(ErroneousMessageReportPayload, { debug: 1 }).then((res: any) => {}); diff --git a/types/clevertap/index.d.ts b/types/clevertap/index.d.ts index 53985e224cbf1b2..669c4fc4839e390 100644 --- a/types/clevertap/index.d.ts +++ b/types/clevertap/index.d.ts @@ -43,6 +43,11 @@ interface Query { to: number; } +interface MessageReportQuery { + from: string; + to: string; +} + interface QueryOptions { debug?: number; batchSize?: number; @@ -133,6 +138,7 @@ interface CleverTap { options?: TargetOptions, callback?: Callback, ): Promise; + getMessageReports(query: MessageReportQuery, options?: QueryOptions, callback?: Callback): Promise; readonly TARGET_CREATE: "create"; readonly TARGET_ESTIMATE: "estimate"; readonly TARGET_LIST: "list"; diff --git a/types/clownface/package.json b/types/clownface/package.json index 4e6e681c6edc0a4..cb5e2d0d63b75b8 100644 --- a/types/clownface/package.json +++ b/types/clownface/package.json @@ -7,7 +7,7 @@ ], "type": "module", "dependencies": { - "@rdfjs/types": ">=1.0.0", + "@rdfjs/types": ">=1", "@types/rdfjs__environment": "*" }, "devDependencies": { diff --git a/types/configs-overload/configs-overload-tests.ts b/types/configs-overload/configs-overload-tests.ts index e2aadd17d94aa82..1d6703ec7b242c1 100644 --- a/types/configs-overload/configs-overload-tests.ts +++ b/types/configs-overload/configs-overload-tests.ts @@ -1,8 +1,14 @@ -import configsOverload from "configs-overload"; +import configsOverload, { ConfigsOverloadOptions, ExtendableConfig } from "configs-overload"; +// $ExpectType ExtendableConfig configsOverload(); +// $ExpectType ExtendableConfig configsOverload("./configs"); +// $ExpectType ExtendableConfig configsOverload("./configs", {}); +// $ExpectType ExtendableConfig configsOverload("./configs", { defaultEnv: "default" }); +// $ExpectType ExtendableConfig configsOverload("./configs", { env: "production" }); +// $ExpectType ExtendableConfig configsOverload("./configs", { defaultEnv: "default", env: "production" }); diff --git a/types/configs-overload/index.d.ts b/types/configs-overload/index.d.ts index 728af1e63080bed..340a7c11de89fa8 100644 --- a/types/configs-overload/index.d.ts +++ b/types/configs-overload/index.d.ts @@ -1,10 +1,17 @@ -export interface ConfigsOverloadOptions { - defaultEnv?: string | undefined; - env?: string | undefined; -} +declare namespace configsOverload { + interface ConfigsOverloadOptions { + defaultEnv?: string | undefined; + env?: string | undefined; + } -export interface ExtendableConfig { - [key: string]: any; + interface ExtendableConfig { + [key: string]: any; + } } -export default function configsOverload(configsDirectory?: string, options?: ConfigsOverloadOptions): ExtendableConfig; +declare function configsOverload( + configsDirectory?: string, + options?: configsOverload.ConfigsOverloadOptions, +): configsOverload.ExtendableConfig; + +export = configsOverload; diff --git a/types/consul/.eslintrc.json b/types/consul/.eslintrc.json deleted file mode 100644 index dba3f7c889148e7..000000000000000 --- a/types/consul/.eslintrc.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "rules": { - "@definitelytyped/no-unnecessary-generics": "off", - "@typescript-eslint/no-unsafe-function-type": "off", - "@typescript-eslint/no-wrapper-object-types": "off", - "@typescript-eslint/no-empty-interface": "off" - } -} diff --git a/types/consul/consul-tests.ts b/types/consul/consul-tests.ts deleted file mode 100644 index 5f4b9ba6a1b5aad..000000000000000 --- a/types/consul/consul-tests.ts +++ /dev/null @@ -1,788 +0,0 @@ -import Consul = require("consul"); - -let ConsulStatic: Consul.ConsulStatic; -let AclStatic: Consul.AclStatic = ConsulStatic.Acl; -let AgentStatic: Consul.AgentStatic = ConsulStatic.Agent; -let AgentCheckStatic: Consul.Agent.CheckStatic = ConsulStatic.Agent.Check; -let AgentServiceStatic: Consul.Agent.ServiceStatic = ConsulStatic.Agent.Service; -let CatalogStatic: Consul.CatalogStatic = ConsulStatic.Catalog; -let CatalogNodeStatic: Consul.Catalog.NodeStatic = ConsulStatic.Catalog.Node; -let CatalogServiceStatic: Consul.Catalog.ServiceStatic = ConsulStatic.Catalog.Service; -let EventStatic: Consul.EventStatic = ConsulStatic.Event; -let HealthStatic: Consul.HealthStatic = ConsulStatic.Health; -let KvStatic: Consul.KvStatic = ConsulStatic.Kv; -let LockStatic: Consul.LockStatic = ConsulStatic.Lock; -let SessionStatic: Consul.SessionStatic = ConsulStatic.Session; -let StatusStatic: Consul.StatusStatic = ConsulStatic.Status; -let WatchStatic: Consul.WatchStatic = ConsulStatic.Watch; - -let consul: Consul.Consul; - -consul = Consul(); -consul = new Consul(); - -// Consul.Acl -{ - let acl: Consul.Acl = consul.acl; - - acl = new AclStatic(consul); - consul = acl.consul; - - { - let opts: Consul.Acl.CreateOptions; - let callback: Consul.Callback; - let result: Promise; - - acl.create(opts, callback); - acl.create(callback); - - result = acl.create(opts); - result = acl.create(); - } - - { - let opts: Consul.Acl.UpdateOptions; - let callback: Consul.Callback; - let result: Promise; - - acl.update(opts, callback); - - result = acl.update(opts); - } - - { - let id: string; - let opts: Consul.Acl.DestroyOptions; - let callback: Consul.Callback; - let result: Promise; - - acl.destroy(id, callback); - acl.destroy(opts, callback); - - result = acl.destroy(id); - result = acl.destroy(opts); - } - - { - let id: string; - let opts: Consul.Acl.InfoOptions; - let callback: Consul.Callback; - let result: Promise; - - acl.info(id, callback); - acl.info(opts, callback); - - result = acl.info(id); - result = acl.info(opts); - - acl.get(id, callback); - acl.get(opts, callback); - - result = acl.get(id); - result = acl.get(opts); - } - - { - let id: string; - let opts: Consul.Acl.CloneOptions; - let callback: Consul.Callback; - let result: Promise; - - acl.clone(id, callback); - acl.clone(opts, callback); - - result = acl.clone(id); - result = acl.clone(opts); - } - - { - let opts: Consul.Acl.ListOptions; - let callback: Consul.Callback; - let result: Promise; - - acl.list(opts, callback); - acl.list(callback); - - result = acl.list(opts); - result = acl.list(); - } -} - -// Consul.Agent -{ - let agent: Consul.Agent = consul.agent; - - agent = new AgentStatic(consul); - consul = agent.consul; - - { - let opts: Consul.Agent.ChecksOptions; - let callback: Consul.Callback; - let result: Promise; - - agent.checks(opts, callback); - agent.checks(callback); - - result = agent.checks(opts); - result = agent.checks(); - } - - { - let opts: Consul.Agent.ServicesOptions; - let callback: Consul.Callback; - let result: Promise; - - agent.services(opts, callback); - agent.services(callback); - - result = agent.services(opts); - result = agent.services(); - } - - { - let opts: Consul.Agent.MembersOptions; - let callback: Consul.Callback; - let result: Promise; - - agent.members(opts, callback); - agent.members(callback); - - result = agent.members(opts); - result = agent.members(); - } - - { - let opts: Consul.Agent.SelfOptions; - let callback: Consul.Callback; - let result: Promise; - - agent.self(opts, callback); - agent.self(callback); - - result = agent.self(opts); - result = agent.self(); - } - - { - let enable: boolean; - let opts: Consul.Agent.MaintenanceOptions; - let callback: Consul.Callback; - let result: Promise; - - agent.maintenance(enable, callback); - agent.maintenance(opts, callback); - - result = agent.maintenance(enable); - result = agent.maintenance(opts); - } - - { - let address: string; - let opts: Consul.Agent.JoinOptions; - let callback: Consul.Callback; - let result: Promise; - - agent.join(address, callback); - agent.join(opts, callback); - - result = agent.join(address); - result = agent.join(opts); - } - - { - let node: string; - let opts: Consul.Agent.ForceLeaveOptions; - let callback: Consul.Callback; - let result: Promise; - - agent.forceLeave(node, callback); - agent.forceLeave(opts, callback); - - result = agent.forceLeave(node); - result = agent.forceLeave(opts); - } - - // Consul.Agent.Check - { - let check: Consul.Agent.Check = consul.agent.check; - - check = new AgentCheckStatic(consul); - consul = check.consul; - - { - let id: string; - let opts: Consul.Agent.Check.ListOptions; - let callback: Consul.Callback; - let result: Promise; - - check.list(opts, callback); - check.list(callback); - - result = check.list(opts); - result = check.list(); - } - - { - let opts: Consul.Agent.Check.RegisterOptions; - let callback: Consul.Callback; - let result: Promise; - - check.register(opts, callback); - - result = check.register(opts); - } - - { - let id: string; - let opts: Consul.Agent.Check.DeregisterOptions; - let callback: Consul.Callback; - let result: Promise; - - check.deregister(id, callback); - check.deregister(opts, callback); - - result = check.deregister(id); - result = check.deregister(opts); - } - - { - let id: string; - let opts: Consul.Agent.Check.PassOptions; - let callback: Consul.Callback; - let result: Promise; - - check.pass(id, callback); - check.pass(opts, callback); - - result = check.pass(id); - result = check.pass(opts); - } - - { - let id: string; - let opts: Consul.Agent.Check.WarnOptions; - let callback: Consul.Callback; - let result: Promise; - - check.warn(id, callback); - check.warn(opts, callback); - - result = check.warn(id); - result = check.warn(opts); - } - - { - let id: string; - let opts: Consul.Agent.Check.WarnOptions; - let callback: Consul.Callback; - let result: Promise; - - check.fail(id, callback); - check.fail(opts, callback); - - result = check.fail(id); - result = check.fail(opts); - } - } - - // Consul.Agent.Service - { - let service: Consul.Agent.Service = consul.agent.service; - - service = new AgentServiceStatic(consul); - consul = service.consul; - - { - let opts: Consul.Agent.Service.ListOptions; - let callback: Consul.Callback; - let result: Promise; - - service.list(opts, callback); - service.list(callback); - - result = service.list(opts); - result = service.list(); - } - - { - let id: string; - let opts: Consul.Agent.Service.RegisterOptions; - let callback: Consul.Callback; - let result: Promise; - - service.register(id, callback); - service.register(opts, callback); - - result = service.register(id); - result = service.register(opts); - } - - { - let id: string; - let opts: Consul.Agent.Service.DeregisterOptions; - let callback: Consul.Callback; - let result: Promise; - - service.deregister(id, callback); - service.deregister(opts, callback); - - result = service.deregister(id); - result = service.deregister(opts); - } - - { - let opts: Consul.Agent.Service.MaintenanceOptions; - let callback: Consul.Callback; - let result: Promise; - - service.maintenance(opts, callback); - - result = service.maintenance(opts); - } - } -} - -// Consul.Catalog -{ - let catalog: Consul.Catalog = consul.catalog; - - catalog = new CatalogStatic(consul); - consul = catalog.consul; - - { - let opts: Consul.Catalog.DatacentersOptions; - let callback: Consul.Callback; - let result: Promise; - - catalog.datacenters(opts, callback); - catalog.datacenters(callback); - - result = catalog.datacenters(opts); - result = catalog.datacenters(); - } - - { - let dc: string; - let opts: Consul.Catalog.NodesOptions; - let callback: Consul.Callback; - let result: Promise; - - catalog.nodes(dc, callback); - catalog.nodes(opts, callback); - catalog.nodes(callback); - - result = catalog.nodes(dc); - result = catalog.nodes(opts); - result = catalog.nodes(); - } - - { - let dc: string; - let opts: Consul.Catalog.ServicesOptions; - let callback: Consul.Callback; - let result: Promise; - - catalog.services(dc, callback); - catalog.services(opts, callback); - catalog.services(callback); - - result = catalog.services(dc); - result = catalog.services(opts); - result = catalog.services(); - } - - // Consul.Catalog.Node - { - let node: Consul.Catalog.Node = consul.catalog.node; - - node = new CatalogNodeStatic(consul); - consul = node.consul; - - { - let dc: string; - let opts: Consul.Catalog.Node.ListOptions; - let callback: Consul.Callback; - let result: Promise; - - node.list(dc, callback); - node.list(opts, callback); - node.list(callback); - - result = node.list(dc); - result = node.list(opts); - result = node.list(); - } - - { - let nodeOption: string; - let opts: Consul.Catalog.Node.ServicesOptions; - let callback: Consul.Callback; - let result: Promise; - - node.services(nodeOption, callback); - node.services(opts, callback); - - result = node.services(nodeOption); - result = node.services(opts); - } - } - - // Consul.Catalog.Service - { - let service: Consul.Catalog.Service = consul.catalog.service; - - service = new CatalogServiceStatic(consul); - consul = service.consul; - - { - let dc: string; - let opts: Consul.Catalog.Service.ListOptions; - let callback: Consul.Callback; - let result: Promise; - - service.list(dc, callback); - service.list(opts, callback); - service.list(callback); - - result = service.list(dc); - result = service.list(opts); - result = service.list(); - } - - { - let serviceOption: string; - let opts: Consul.Catalog.Service.NodesOptions; - let callback: Consul.Callback; - let result: Promise; - - service.nodes(serviceOption, callback); - service.nodes(opts, callback); - - result = service.nodes(serviceOption); - result = service.nodes(opts); - } - } -} - -// Consul.Event -{ - let event: Consul.Event = consul.event; - - event = new EventStatic(consul); - consul = event.consul; - - { - let name: string; - let payload: string | Buffer; - let opts: Consul.Event.FireOptions; - let callback: Consul.Callback; - let result: Promise; - - event.fire(name, payload, callback); - event.fire(name, callback); - event.fire(opts, callback); - - result = event.fire(name, payload); - result = event.fire(name); - result = event.fire(opts); - } - - { - let name: string; - let opts: Consul.Event.ListOptions; - let callback: Consul.Callback; - let result: Promise; - - event.list(name, callback); - event.list(opts, callback); - event.list(callback); - - result = event.list(name); - result = event.list(opts); - result = event.list(); - } -} - -// Consul.Health -{ - let health: Consul.Health = consul.health; - let name: string; - - health = new HealthStatic(consul); - consul = health.consul; - - { - let node: string; - let opts: Consul.Health.NodeOptions; - let callback: Consul.Callback; - let result: Promise; - - health.node(name, callback); - health.node(opts, callback); - - result = health.node(name); - result = health.node(opts); - } - - { - let service: string; - let opts: Consul.Health.ChecksOptions; - let callback: Consul.Callback; - let result: Promise; - - health.checks(service, callback); - health.checks(opts, callback); - - result = health.checks(service); - result = health.checks(opts); - } - - { - let service: string; - let opts: Consul.Health.ServiceOptions; - let callback: Consul.Callback; - let result: Promise; - - health.service(service, callback); - health.service(opts, callback); - - result = health.service(service); - result = health.service(opts); - } - - { - let state: string; - let opts: Consul.Health.StateOptions; - let callback: Consul.Callback; - let result: Promise; - - health.state(state, callback); - health.state(opts, callback); - - result = health.state(state); - result = health.state(opts); - } -} - -// Consul.Kv -{ - let kv: Consul.Kv = consul.kv; - - kv = new KvStatic(consul); - consul = kv.consul; - - { - let key: string; - let opts: Consul.Kv.GetOptions; - let callback: Consul.Callback; - let result: Promise; - - kv.get(key, callback); - kv.get(opts, callback); - - result = kv.get(key); - result = kv.get(opts); - } - - { - let key: string; - let opts: Consul.Kv.KeysOptions; - let callback: Consul.Callback; - let result: Promise; - - kv.keys(key, callback); - kv.keys(opts, callback); - kv.keys(callback); - - result = kv.keys(key); - result = kv.keys(opts); - result = kv.keys(); - } - - { - let key: string; - let value: string | Buffer; - let opts: Consul.Kv.SetOptions; - let callback: Consul.Callback; - let result: Promise; - - kv.set(key, value, opts, callback); - kv.set(key, value, callback); - kv.set(opts, callback); - - result = kv.set(key, value, opts); - result = kv.set(key, value); - result = kv.set(opts); - } - - { - let key: string; - let opts: Consul.Kv.DelOptions; - let callback: Consul.Callback; - let result: Promise; - - kv.del(key, callback); - kv.del(opts, callback); - - result = kv.del(key); - result = kv.del(opts); - - kv.delete(key, callback); - kv.delete(opts, callback); - - result = kv.delete(key); - result = kv.delete(opts); - } -} - -// Consul.Lock -{ - let lock: Consul.Lock; - let opts: Consul.Lock.Options; - - lock = new LockStatic(consul, opts); - lock = consul.lock(opts); - consul = lock.consul; - - lock.acquire(); - - lock.release(); -} - -// Consul.Session -{ - let session: Consul.Session = consul.session; - - session = new SessionStatic(consul); - consul = session.consul; - - { - let opts: Consul.Session.CreateOptions; - let callback: Consul.Callback; - let result: Promise; - - session.create(opts, callback); - session.create(callback); - - result = session.create(opts); - result = session.create(); - } - - { - let id: string; - let opts: Consul.Session.DestroyOptions; - let callback: Consul.Callback; - let result: Promise; - - session.destroy(id, callback); - session.destroy(opts, callback); - - result = session.destroy(id); - result = session.destroy(opts); - } - - { - let id: string; - let opts: Consul.Session.InfoOptions; - let callback: Consul.Callback; - let result: Promise; - - session.info(id, callback); - session.info(opts, callback); - - result = session.info(id); - result = session.info(opts); - - session.get(id, callback); - session.get(opts, callback); - - result = session.get(id); - result = session.get(opts); - } - - { - let node: string; - let opts: Consul.Session.NodeOptions; - let callback: Consul.Callback; - let result: Promise; - - session.node(node, callback); - session.node(opts, callback); - - result = session.node(node); - result = session.node(opts); - } - - { - let opts: Consul.Session.ListOptions; - let callback: Consul.Callback; - let result: Promise; - - session.list(opts, callback); - session.list(callback); - - result = session.list(opts); - result = session.list(); - } - - { - let id: string; - let opts: Consul.Session.RenewOptions; - let callback: Consul.Callback; - let result: Promise; - - session.renew(id, callback); - session.renew(opts, callback); - - result = session.renew(id); - result = session.renew(opts); - } -} - -// Consul.Status -{ - let status: Consul.Status = consul.status; - - status = new StatusStatic(consul); - consul = status.consul; - - { - let opts: Consul.Status.LeaderOptions; - let callback: Consul.Callback; - let result: Promise; - - status.leader(opts, callback); - status.leader(callback); - - result = status.leader(opts); - result = status.leader(); - } - - { - let opts: Consul.Status.LeaderOptions; - let callback: Consul.Callback; - let result: Promise; - - status.peers(opts, callback); - status.peers(callback); - - result = status.peers(opts); - result = status.peers(); - } -} - -// Consul.Watch -{ - let watch: Consul.Watch; - let opts: Consul.Watch.Options; - - watch = new WatchStatic(consul, opts); - watch = consul.watch(opts); - consul = watch.consul; - - watch.isRunning(); - - watch.updateTime(); - - watch.end(); -} diff --git a/types/consul/index.d.ts b/types/consul/index.d.ts deleted file mode 100644 index 04838629106dabd..000000000000000 --- a/types/consul/index.d.ts +++ /dev/null @@ -1,1011 +0,0 @@ -/// - -import { IncomingMessage as HttpIncomingMessage } from "http"; - -declare namespace Consul { - interface CommonOptions { - consistent?: boolean | undefined; - dc?: string | undefined; - stale?: boolean | undefined; - token?: string | undefined; - wait?: string | undefined; - wan?: boolean | undefined; - - ctx?: NodeJS.EventEmitter | undefined; - timeout?: number | undefined; - } - - interface Response extends HttpIncomingMessage { - body?: Object | string | Buffer | undefined; - } - - interface Callback { - (err?: Error, data?: TData, res?: Response): any; - } - - namespace Acl { - interface CreateOptions extends CommonOptions { - name?: string | undefined; - type?: string | undefined; - rules?: string | undefined; - } - - interface UpdateOptions extends CommonOptions { - id: string; - name?: string | undefined; - type?: string | undefined; - rules?: string | undefined; - } - - interface DestroyOptions extends CommonOptions { - id: string; - } - - interface InfoOptions extends CommonOptions { - id: string; - } - - interface GetOptions extends InfoOptions {} - - interface CloneOptions extends CommonOptions { - id: string; - } - - interface ListOptions extends CommonOptions {} - } - - interface Acl { - consul: Consul; - - /** - * Creates a new token with policy - */ - create: { - (opts: Acl.CreateOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Acl.CreateOptions): Promise; - }; - - /** - * Update the policy of a token - */ - update: { - (opts: Acl.UpdateOptions, callback: Callback): void; - (opts: Acl.UpdateOptions): Promise; - }; - - /** - * Destroys a given token - */ - destroy: { - (id: string, callback: Callback): void; - (opts: Acl.DestroyOptions, callback: Callback): void; - (id: string): Promise; - (opts: Acl.DestroyOptions): Promise; - }; - - /** - * Queries the policy of a given token - */ - info: { - (id: string, callback: Callback): void; - (opts: Acl.InfoOptions, callback: Callback): void; - (id: string): Promise; - (opts: Acl.InfoOptions): Promise; - }; - get: { - (id: string, callback: Callback): void; - (opts: Acl.GetOptions, callback: Callback): void; - (id: string): Promise; - (opts: Acl.GetOptions): Promise; - }; - - /** - * Creates a new token by cloning an existing token - */ - clone: { - (id: string, callback: Callback): void; - (opts: Acl.CloneOptions, callback: Callback): void; - (id: string): Promise; - (opts: Acl.CloneOptions): Promise; - }; - - /** - * Lists all the active tokens - */ - list: { - (opts: Acl.ListOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Acl.ListOptions): Promise; - }; - } - - interface AclStatic { - new(consul: Consul): Acl; - } - - namespace Agent { - namespace Check { - interface ListOptions extends CommonOptions {} - - interface RegisterOptions extends CommonOptions { - name: string; - id?: string | undefined; - serviceid?: string | undefined; - http?: string | undefined; - script?: string | undefined; - interval?: string | undefined; - ttl?: string | undefined; - notes?: string | undefined; - status?: string | undefined; - } - - interface DeregisterOptions extends CommonOptions { - id: string; - } - - interface PassOptions extends CommonOptions { - id: string; - note?: string | undefined; - } - - interface WarnOptions extends CommonOptions { - id: string; - note?: string | undefined; - } - - interface FailOptions extends CommonOptions { - id: string; - note?: string | undefined; - } - } - - interface Check { - consul: Consul; - - /** - * Returns the checks the local agent is managing - */ - list: { - (opts: Check.ListOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Check.ListOptions): Promise; - }; - - /** - * Registers a new local check - */ - register: { - (opts: Check.RegisterOptions, callback: Callback): void; - (opts: Check.RegisterOptions): Promise; - }; - - /** - * Deregister a local check - */ - deregister: { - (id: string, callback: Callback): void; - (opts: Check.DeregisterOptions, callback: Callback): void; - (id: string): Promise; - (opts: Check.DeregisterOptions): Promise; - }; - - /** - * Mark a local test as passing - */ - pass: { - (id: string, callback: Callback): void; - (opts: Check.PassOptions, callback: Callback): void; - (id: string): Promise; - (opts: Check.PassOptions): Promise; - }; - - /** - * Mark a local test as warning - */ - warn: { - (id: string, callback: Callback): void; - (opts: Check.WarnOptions, callback: Callback): void; - (id: string): Promise; - (opts: Check.WarnOptions): Promise; - }; - - /** - * Mark a local test as critical - */ - fail: { - (id: string, callback: Callback): void; - (opts: Check.FailOptions, callback: Callback): void; - (id: string): Promise; - (opts: Check.FailOptions): Promise; - }; - } - - interface CheckStatic { - new(consul: Consul): Check; - } - - namespace Service { - interface RegisterCheck { - http?: string | undefined; - script?: string | undefined; - interval?: string | undefined; - ttl?: string | undefined; - notes?: string | undefined; - status?: string | undefined; - } - - interface ListOptions extends CommonOptions {} - - interface RegisterOptions extends CommonOptions { - name: string; - id?: string | undefined; - tags?: string[] | undefined; - address?: string | undefined; - port?: number | undefined; - meta?: Record | undefined; - check?: RegisterCheck | undefined; - checks?: RegisterCheck[] | undefined; - } - - interface DeregisterOptions extends CommonOptions { - id: string; - } - - interface MaintenanceOptions extends CommonOptions { - id: string; - enable: boolean; - reason?: string | undefined; - } - } - - interface Service { - consul: Consul; - - /** - * Returns the services local agent is managing - */ - list: { - (opts: Service.ListOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Service.ListOptions): Promise; - }; - - /** - * Registers a new local service - */ - register: { - (name: string, callback: Callback): void; - (opts: Service.RegisterOptions, callback: Callback): void; - (name: string): Promise; - (opts: Service.RegisterOptions): Promise; - }; - - /** - * Deregister a local service - */ - deregister: { - (id: string, callback: Callback): void; - (opts: Service.DeregisterOptions, callback: Callback): void; - (id: string): Promise; - (opts: Service.DeregisterOptions): Promise; - }; - - /** - * Manages node maintenance mode - */ - maintenance: { - (opts: Service.MaintenanceOptions, callback: Callback): void; - (opts: Service.MaintenanceOptions): Promise; - }; - } - - interface ServiceStatic { - new(consul: Consul): Service; - } - - interface ChecksOptions extends Check.ListOptions {} - - interface ServicesOptions extends Service.ListOptions {} - - interface MembersOptions extends CommonOptions { - wan?: boolean | undefined; - } - - interface SelfOptions extends CommonOptions {} - - interface MaintenanceOptions extends CommonOptions { - enable: boolean; - reason?: string | undefined; - } - - interface JoinOptions extends CommonOptions { - address: string; - wan?: boolean | undefined; - } - - interface ForceLeaveOptions extends CommonOptions { - node: string; - } - } - - interface Agent { - consul: Consul; - check: Agent.Check; - service: Agent.Service; - - /** - * Returns the checks the local agent is managing - */ - checks: { - (opts: Agent.ChecksOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Agent.ChecksOptions): Promise; - }; - - /** - * Returns the services local agent is managing - */ - services: { - (opts: Agent.ServicesOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Agent.ServicesOptions): Promise; - }; - - /** - * Returns the members as seen by the local consul agent - */ - members: { - (opts: Agent.MembersOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Agent.MembersOptions): Promise; - }; - - /** - * Returns the local node configuration - */ - self: { - (opts: Agent.SelfOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Agent.SelfOptions): Promise; - }; - - /** - * Manages node maintenance mode - */ - maintenance: { - (enable: boolean, callback: Callback): void; - (opts: Agent.MaintenanceOptions, callback: Callback): void; - (enable: boolean): Promise; - (opts: Agent.MaintenanceOptions): Promise; - }; - - /** - * Trigger local agent to join a node - */ - join: { - (address: string, callback: Callback): void; - (opts: Agent.JoinOptions, callback: Callback): void; - (address: string): Promise; - (opts: Agent.JoinOptions): Promise; - }; - - /** - * Force remove node - */ - forceLeave: { - (node: string, callback: Callback): void; - (opts: Agent.ForceLeaveOptions, callback: Callback): void; - (node: string): Promise; - (opts: Agent.ForceLeaveOptions): Promise; - }; - } - - interface AgentStatic { - new(consul: Consul): Agent; - - Check: Agent.CheckStatic; - Service: Agent.ServiceStatic; - } - - namespace Catalog { - namespace Node { - interface ListOptions extends CommonOptions { - dc?: string | undefined; - } - - interface ServicesOptions extends CommonOptions { - node: string; - } - } - - interface Node { - consul: Consul; - - /** - * Lists nodes in a given DC - */ - list: { - (dc: string, callback: Callback): void; - (opts: Node.ListOptions, callback: Callback): void; - (callback: Callback): void; - (dc?: string): Promise; - (opts?: Node.ListOptions): Promise; - }; - - /** - * Lists the services provided by a node - */ - services: { - (node: string, callback: Callback): void; - (opts: Node.ServicesOptions, callback: Callback): void; - (node: string): Promise; - (opts: Node.ServicesOptions): Promise; - }; - } - - interface NodeStatic { - new(consul: Consul): Node; - } - - namespace Service { - interface ListOptions extends CommonOptions { - dc?: string | undefined; - } - - interface NodesOptions extends CommonOptions { - service: string; - dc?: string | undefined; - tag?: string | undefined; - } - } - - interface Service { - consul: Consul; - - /** - * Lists services in a given DC - */ - list: { - (dc: string, callback: Callback): void; - (opts: Service.ListOptions, callback: Callback): void; - (callback: Callback): void; - (dc?: string): Promise; - (opts?: Service.ListOptions): Promise; - }; - - /** - * Lists the nodes in a given service - */ - nodes: { - (service: string, callback: Callback): void; - (opts: Service.NodesOptions, callback: Callback): void; - (service: string): Promise; - (opts: Service.NodesOptions): Promise; - }; - } - - interface ServiceStatic { - new(consul: Consul): Service; - } - - interface DatacentersOptions extends CommonOptions {} - - interface NodesOptions extends Node.ListOptions {} - - interface ServicesOptions extends Service.ListOptions {} - } - - interface Catalog { - consul: Consul; - node: Catalog.Node; - service: Catalog.Service; - - /** - * Lists known datacenters - */ - datacenters: { - (opts: Catalog.DatacentersOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Catalog.DatacentersOptions): Promise; - }; - - /** - * Lists nodes in a given DC - */ - nodes: { - (dc: string, callback: Callback): void; - (opts: Catalog.NodesOptions, callback: Callback): void; - (callback: Callback): void; - (dc?: string): Promise; - (opts?: Catalog.NodesOptions): Promise; - }; - - /** - * Lists services in a given DC - */ - services: { - (dc: string, callback: Callback): void; - (opts: Catalog.ServicesOptions, callback: Callback): void; - (callback: Callback): void; - (dc?: string): Promise; - (opts?: Catalog.ServicesOptions): Promise; - }; - } - - interface CatalogStatic { - new(consul: Consul): Catalog; - - Node: Catalog.NodeStatic; - Service: Catalog.ServiceStatic; - } - - namespace Event { - interface FireOptions extends CommonOptions { - name: string; - payload: string | Buffer; - node?: string | undefined; - service?: string | undefined; - tag?: string | undefined; - } - - interface ListOptions extends CommonOptions { - name?: string | undefined; - } - } - - interface Event { - consul: Consul; - - /** - * Fires a new user event - */ - fire: { - (name: string, payload: string | Buffer, callback: Callback): void; - (name: string, callback: Callback): void; - (opts: Event.FireOptions, callback: Callback): void; - (name: string, payload: string | Buffer): Promise; - (name: string): Promise; - (opts: Event.FireOptions): Promise; - }; - - /** - * Lists the most recent events an agent has seen - */ - list: { - (name: string, callback: Callback): void; - (opts: Event.ListOptions, callback: Callback): void; - (callback: Callback): void; - (name?: string): Promise; - (opts?: Event.ListOptions): Promise; - }; - } - - interface EventStatic { - new(consul: Consul): Event; - } - - namespace Health { - interface NodeOptions extends CommonOptions { - node: string; - dc?: string | undefined; - } - - interface ChecksOptions extends CommonOptions { - service: string; - dc?: string | undefined; - } - - interface ServiceOptions extends CommonOptions { - service: string; - dc?: string | undefined; - tag?: string | undefined; - passing?: boolean | undefined; - near?: string | undefined; - } - - interface StateOptions extends CommonOptions { - state: string; - dc?: string | undefined; - } - } - - interface Health { - consul: Consul; - - /** - * Returns the health info of a node - */ - node: { - (node: string, callback: Callback): void; - (opts: Health.NodeOptions, callback: Callback): void; - (node: string): Promise; - (opts: Health.NodeOptions): Promise; - }; - - /** - * Returns the checks of a service - */ - checks: { - (service: string, callback: Callback): void; - (opts: Health.ChecksOptions, callback: Callback): void; - (service: string): Promise; - (opts: Health.ChecksOptions): Promise; - }; - - /** - * Returns the nodes and health info of a service - */ - service: { - (service: string, callback: Callback): void; - (opts: Health.ServiceOptions, callback: Callback): void; - (service: string): Promise; - (opts: Health.ServiceOptions): Promise; - }; - - /** - * Returns the checks in a given state - */ - state: { - (state: string, callback: Callback): void; - (opts: Health.StateOptions, callback: Callback): void; - (state: string): Promise; - (opts: Health.StateOptions): Promise; - }; - } - - interface HealthStatic { - new(consul: Consul): Health; - } - - namespace Kv { - interface GetOptions extends CommonOptions { - key: string; - dc?: string | undefined; - recurse?: boolean | undefined; - index?: string | undefined; - wait?: string | undefined; - raw?: boolean | undefined; - buffer?: boolean | undefined; - } - - interface KeysOptions extends CommonOptions { - key: string; - dc?: string | undefined; - separator?: string | undefined; - } - - interface SetOptions extends CommonOptions { - key: string; - value: string | Buffer; - dc?: string | undefined; - flags?: number | undefined; - cas?: string | undefined; - acquire?: string | undefined; - release?: string | undefined; - } - - interface DelOptions extends CommonOptions { - key: string; - dc?: string | undefined; - recurse?: boolean | undefined; - cas?: string | undefined; - } - - interface DeleteOptions extends DelOptions {} - } - - interface Kv { - consul: Consul; - - /** - * Get - */ - get: { - (key: string, callback: Callback): void; - (opts: Kv.GetOptions, callback: Callback): void; - (key: string): Promise; - (opts: Kv.GetOptions): Promise; - }; - - /** - * Keys - */ - keys: { - (key: string, callback: Callback): void; - (opts: Kv.KeysOptions, callback: Callback): void; - (callback: Callback): void; - (key?: string): Promise; - (opts?: Kv.KeysOptions): Promise; - }; - - /** - * Set - */ - set: { - (key: string, value: string | Buffer, opts: Kv.SetOptions, callback: Callback): void; - (key: string, value: string | Buffer, callback: Callback): void; - (opts: Kv.SetOptions, callback: Callback): void; - (key: string, value: string | Buffer, opts: Kv.SetOptions): Promise; - (key: string, value: string | Buffer): Promise; - (opts: Kv.SetOptions): Promise; - }; - - /** - * Delete - */ - del: { - (key: string, callback: Callback): void; - (opts: Kv.DelOptions, callback: Callback): void; - (key: string): Promise; - (opts: Kv.DelOptions): Promise; - }; - delete: { - (key: string, callback: Callback): void; - (opts: Kv.DeleteOptions, callback: Callback): void; - (key: string): Promise; - (opts: Kv.DeleteOptions): Promise; - }; - } - - interface KvStatic { - new(consul: Consul): Kv; - } - - namespace Lock { - interface Options { - key: string; - session?: Object | string | undefined; - value?: string | Buffer | undefined; - lockwaittime?: string | undefined; - lockretrytime?: string | undefined; - } - } - - interface Lock extends NodeJS.EventEmitter { - consul: Consul; - - /** - * Acquire lock - */ - acquire(): void; - - /** - * Release lock - */ - release(): void; - } - - interface LockStatic { - new(consul: Consul, opts: Lock.Options): Lock; - } - - namespace Session { - interface CreateOptions extends CommonOptions { - dc?: string | undefined; - lockdelay?: string | undefined; - name?: string | undefined; - node?: string | undefined; - checks?: string[] | undefined; - behavior?: string | undefined; - ttl?: string | undefined; - } - - interface DestroyOptions extends CommonOptions { - id: string; - dc?: string | undefined; - } - - interface InfoOptions extends CommonOptions { - id: string; - dc?: string | undefined; - } - - interface GetOptions extends InfoOptions {} - - interface NodeOptions extends CommonOptions { - node: string; - dc?: string | undefined; - } - - interface ListOptions extends CommonOptions { - dc?: string | undefined; - } - - interface RenewOptions extends CommonOptions { - id: string; - dc?: string | undefined; - } - } - - interface Session { - consul: Consul; - - /** - * Creates a new session - */ - create: { - (opts: Session.CreateOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Session.CreateOptions): Promise; - }; - - /** - * Destroys a given session - */ - destroy: { - (id: string, callback: Callback): void; - (opts: Session.DestroyOptions, callback: Callback): void; - (id: string): Promise; - (opts: Session.DestroyOptions): Promise; - }; - - /** - * Queries a given session - */ - info: { - (id: string, callback: Callback): void; - (opts: Session.InfoOptions, callback: Callback): void; - (id: string): Promise; - (opts: Session.InfoOptions): Promise; - }; - get: { - (id: string, callback: Callback): void; - (opts: Session.GetOptions, callback: Callback): void; - (id: string): Promise; - (opts: Session.GetOptions): Promise; - }; - - /** - * Lists sessions belonging to a node - */ - node: { - (node: string, callback: Callback): void; - (opts: Session.NodeOptions, callback: Callback): void; - (node: string): Promise; - (opts: Session.NodeOptions): Promise; - }; - - /** - * Lists all the active sessions - */ - list: { - (opts: Session.ListOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Session.ListOptions): Promise; - }; - - /** - * Renews a TTL-based session - */ - renew: { - (id: string, callback: Callback): void; - (opts: Session.RenewOptions, callback: Callback): void; - (id: string): Promise; - (opts: Session.RenewOptions): Promise; - }; - } - - interface SessionStatic { - new(consul: Consul): Session; - } - - namespace Status { - interface LeaderOptions extends CommonOptions {} - - interface PeersOptions extends CommonOptions {} - } - - interface Status { - consul: Consul; - - /** - * Returns the current Raft leader. - */ - leader: { - (opts: Status.LeaderOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Status.LeaderOptions): Promise; - }; - - /** - * Returns the current Raft peer set - */ - peers: { - (opts: Status.PeersOptions, callback: Callback): void; - (callback: Callback): void; - (opts?: Status.PeersOptions): Promise; - }; - } - - interface StatusStatic { - new(consul: Consul): Status; - } - - namespace Watch { - interface WatchOptions { - key?: string | undefined; - } - - interface Options { - method: Function; - options?: CommonOptions & WatchOptions | undefined; - backoffFactor?: number | undefined; - backoffMax?: number | undefined; - maxAttempts?: number | undefined; - } - } - - interface Watch extends NodeJS.EventEmitter { - consul: Consul; - - /** - * Is running - */ - isRunning(): boolean; - - /** - * Update time - */ - updateTime(): number; - - /** - * End watch - */ - end(): void; - } - - interface WatchStatic { - new(consul: Consul, opts: Watch.Options): Watch; - } - - interface ConsulOptions { - host?: string | undefined; - port?: string | undefined; - secure?: boolean | undefined; - ca?: string[] | undefined; - defaults?: CommonOptions | undefined; - promisify?: boolean | Function | undefined; - } - - interface Consul { - acl: Acl; - agent: Agent; - catalog: Catalog; - event: Event; - health: Health; - kv: Kv; - session: Session; - status: Status; - - /** - * Lock helper. - */ - lock(opts: Lock.Options): Lock; - - /** - * Watch helper. - */ - watch(opts: Watch.Options): Watch; - } - - interface ConsulStatic { - (opts?: ConsulOptions): Consul; - new(opts?: ConsulOptions): Consul; - - Acl: AclStatic; - Agent: AgentStatic; - Catalog: CatalogStatic; - Event: EventStatic; - Health: HealthStatic; - Kv: KvStatic; - Lock: LockStatic; - Session: SessionStatic; - Status: StatusStatic; - Watch: WatchStatic; - } -} - -declare let Consul: Consul.ConsulStatic; - -export = Consul; diff --git a/types/consul/package.json b/types/consul/package.json deleted file mode 100644 index c9312c5be296878..000000000000000 --- a/types/consul/package.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "private": true, - "name": "@types/consul", - "version": "0.40.9999", - "projects": [ - "https://github.com/silas/node-consul" - ], - "dependencies": { - "@types/node": "*" - }, - "devDependencies": { - "@types/consul": "workspace:." - }, - "owners": [ - { - "name": "Ilya Mochalov", - "githubUsername": "chrootsu" - }, - { - "name": "Vadym Vakhovskiy", - "githubUsername": "vadim-v" - }, - { - "name": "Radoslav Kirilov", - "githubUsername": "smoke" - } - ] -} diff --git a/types/consumer-data-standards/README.md b/types/consumer-data-standards/README.md index 152bf8d001a6aa7..ec11b56629769a1 100644 --- a/types/consumer-data-standards/README.md +++ b/types/consumer-data-standards/README.md @@ -6,7 +6,7 @@ This fork of the [DefinitelyTyped](https://github.com/DefinitelyTyped/Definitely ## Using the Type Definitions -The Data Standards Body publishes the Type Definitions as a [npm package](https://www.npmjs.com/package/@types/consumer-data-standards). To use these type definitions in your TypeScript projects, you can install them via npm as part of your development dependencies. Please refer to the [Quick Start Guide](#quick-start-guide) section below for more information. +The Data Standards Body publishes the Type Definitions as a [npm package](https://www.npmjs.com/package/@types/consumer-data-standards). To use these type definitions in your TypeScript projects, you can install them via npm as part of your development dependencies. Please refer to the [Quick Start Guide](#quick-start-guide) section below for more information. This tool: @@ -18,29 +18,28 @@ This tool: Please follow these steps to integrate the CDR-specific type definitions into your TypeScript projects: 1. **Install** via npm or Yarn: Depending on your preference, you can use npm or Yarn to install the CDS type definitions package published to npm. - - ```bash - npm install @types/consumer-data-standards - ``` - - Or - - ```bash - yarn install @types/consumer-data-standards - ``` - + + ```bash + npm install @types/consumer-data-standards + ``` + + Or + + ```bash + yarn install @types/consumer-data-standards + ``` + 2. **Usage**: Utilise the types in your TypeScript code as needed: - - ```tsx - import { YourType } from 'your-package'; - - function processData(data: YourType) { - // your code here - } - ``` - -3. **Stay Updated**: Regularly check for updates to ensure you have the latest type definitions. + ```tsx + import { YourType } from "your-package"; + + function processData(data: YourType) { + // your code here + } + ``` + +3. **Stay Updated**: Regularly check for updates to ensure you have the latest type definitions. ## Reporting Issues diff --git a/types/consumer-data-standards/banking/index.d.ts b/types/consumer-data-standards/banking/index.d.ts index 1230c3c5cadbe68..7a039d328dcc913 100644 --- a/types/consumer-data-standards/banking/index.d.ts +++ b/types/consumer-data-standards/banking/index.d.ts @@ -877,6 +877,34 @@ export interface BankingProductConstraint { } /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ +/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ + +export interface BankingProductConstraintV2 { + /** + * Display text providing more information on the constraint. + */ + additionalInfo?: string | null; + /** + * Link to a web page with more information on the constraint. + */ + additionalInfoUri?: string | null; + /** + * Generic field containing additional information relevant to the [_constraintType_](#tocSproductconstrainttypedoc) specified. Whether mandatory or not is dependent on the value of [_constraintType_](#tocSproductconstrainttypedoc). + */ + additionalValue?: string | null; + /** + * The type of constraint described. For further details, refer to [Product Constraint Types](#tocSproductconstrainttypedoc). + */ + constraintType: + | "MAX_BALANCE" + | "MAX_LIMIT" + | "MAX_LVR" + | "MIN_BALANCE" + | "MIN_LIMIT" + | "MIN_LVR" + | "OPENING_BALANCE"; + [k: string]: unknown; +} export interface BankingProductDepositRate { /** * Display text providing more information on the rate. @@ -1443,6 +1471,40 @@ export interface BankingProductDetailV4 extends BankingProductV4 { }>; [k: string]: unknown; } + +/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ + +export type BankingProductDetailV5 = BankingProductV4 & { + /** + * An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also. + */ + bundles?: BankingProductBundle[] | null; + /** + * Array of features available for the product. + */ + features?: BankingProductFeatureV2[] | null; + /** + * Constraints on the application for or operation of the product such as minimum balances or limit thresholds. + */ + constraints?: BankingProductConstraintV2[] | null; + /** + * Eligibility criteria for the product. + */ + eligibility?: BankingProductEligibility[] | null; + /** + * Fees applicable for the product. + */ + fees?: BankingProductFee[] | null; + /** + * Interest rates available for deposits. + */ + depositRates?: BankingProductDepositRate[] | null; + /** + * Interest rates charged against lending balances. + */ + lendingRates?: BankingProductLendingRateV2[] | null; + [k: string]: unknown; +}; /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ export interface BankingProductDiscount { @@ -2876,6 +2938,50 @@ export interface BankingTransactionDetail extends BankingTransaction { } /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ +export type BankingTransactionDetailV2 = BankingTransaction & { + extendedData: { + /** + * Label of the originating payer. Mandatory for inbound payment. + */ + payer?: string; + /** + * Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID). + */ + payee?: string; + /** + * Optional extended data specific to transactions. Currently extended data is supported for NPP service overlays. + */ + extensionUType?: "nppPayload"; + /** + * Required if the _extensionUType_ value is `nppPayload`. + */ + nppPayload?: { + /** + * An extended string description. Required if the _extensionUType_ value is `nppPayload`. + */ + extendedDescription?: string; + /** + * An end to end ID for the payment created at initiation. + */ + endToEndId?: string; + /** + * Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1). + */ + purposeCode?: string; + /** + * Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details. + */ + service: "X2P1" | "IFTI" | "BSCT" | "CATSCT"; + /** + * Two-digit NPP service overlay version with leading zero. + */ + serviceVersion: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; +}; /** * Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). */ @@ -3226,9 +3332,17 @@ export interface MetaPaginatedTransaction { */ isQueryParamUnsupported?: boolean | null; } + +/** + * Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details. + */ +export type NppPaymentService = "X2P1" | "IFTI" | "BSCT" | "CATSCT"; /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ export interface RequestAccountIds { data: { + /** + * Array of _accountId_ values. + */ accountIds: string[]; [k: string]: unknown; }; @@ -5412,6 +5526,45 @@ export interface ResponseBankingProductByIdV4 { } /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ +/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ + +export interface ResponseBankingProductByIdV5 { + data: BankingProductV4 & { + /** + * An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also. + */ + bundles?: BankingProductBundle[] | null; + /** + * Array of features available for the product. + */ + features?: BankingProductFeatureV2[] | null; + /** + * Constraints on the application for or operation of the product such as minimum balances or limit thresholds. + */ + constraints?: BankingProductConstraintV2[] | null; + /** + * Eligibility criteria for the product. + */ + eligibility?: BankingProductEligibility[] | null; + /** + * Fees applicable for the product. + */ + fees?: BankingProductFee[] | null; + /** + * Interest rates available for deposits. + */ + depositRates?: BankingProductDepositRate[] | null; + /** + * Interest rates charged against lending balances. + */ + lendingRates?: BankingProductLendingRateV2[] | null; + [k: string]: unknown; + }; + links: Links; + meta?: null | Meta; + [k: string]: unknown; +} + export interface ResponseBankingProductListV2 { data: { /** @@ -6460,6 +6613,58 @@ export interface ResponseBankingTransactionById { } /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ +/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ + +export interface ResponseBankingTransactionByIdV2 { + data: BankingTransaction & { + extendedData: { + /** + * Label of the originating payer. Mandatory for inbound payment. + */ + payer?: string; + /** + * Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID). + */ + payee?: string; + /** + * Optional extended data specific to transactions. Currently extended data is supported for NPP service overlays. + */ + extensionUType?: "nppPayload"; + /** + * Required if the _extensionUType_ value is `nppPayload`. + */ + nppPayload?: { + /** + * An extended string description. Required if the _extensionUType_ value is `nppPayload`. + */ + extendedDescription?: string; + /** + * An end to end ID for the payment created at initiation. + */ + endToEndId?: string; + /** + * Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1). + */ + purposeCode?: string; + /** + * Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details. + */ + service: "X2P1" | "IFTI" | "BSCT" | "CATSCT"; + /** + * Two-digit NPP service overlay version with leading zero. + */ + serviceVersion: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + links: Links; + meta?: Meta; + [k: string]: unknown; +} + export interface ResponseBankingTransactionList { data: { transactions: Array<{ @@ -6579,11 +6784,11 @@ export interface ResponseBankingTransactionList { * The total number of records in the full set. See [pagination](#pagination). */ totalRecords: number; - [k: string]: unknown; /** * true if "text" query parameter is not supported */ isQueryParamUnsupported?: boolean | null; + [k: string]: unknown; }; [k: string]: unknown; } diff --git a/types/consumer-data-standards/common/index.d.ts b/types/consumer-data-standards/common/index.d.ts index 463faced9fb2797..9aaf58e32db323b 100644 --- a/types/consumer-data-standards/common/index.d.ts +++ b/types/consumer-data-standards/common/index.d.ts @@ -173,7 +173,7 @@ export interface CommonOrganisationDetailV2 extends CommonOrganisation { */ thoroughfareNumber1?: number | null; /** - * Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated + * Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated */ thoroughfareNumber1Suffix?: string | null; /** @@ -181,7 +181,7 @@ export interface CommonOrganisationDetailV2 extends CommonOrganisation { */ thoroughfareNumber2?: number | null; /** - * Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated + * Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated */ thoroughfareNumber2Suffix?: string | null; [k: string]: unknown; diff --git a/types/consumer-data-standards/energy/index.d.ts b/types/consumer-data-standards/energy/index.d.ts index 0d620b2416d50c9..93179286ef6533b 100644 --- a/types/consumer-data-standards/energy/index.d.ts +++ b/types/consumer-data-standards/energy/index.d.ts @@ -5125,7 +5125,7 @@ export interface EnergyPlanSolarFeedInTariffV3 { */ startDate?: string; /** - * The type of the payer + * Reference to the applicable tariff structure */ tariffUType: "singleTariff" | "timeVaryingTariffs"; /** @@ -5398,7 +5398,7 @@ export interface EnergyPlanTariffPeriodV2 { */ dailySupplyCharge?: string; /** - * Specifies if daily supply charge is single or banded. Default value is SINGLE if field not provided + * Specifies if daily supply charge is single or banded. */ dailySupplyChargeType?: "SINGLE" | "BAND"; /** @@ -5769,7 +5769,7 @@ export interface EnergyServicePointDetail { */ thoroughfareNumber1?: number | null; /** - * Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated + * Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated */ thoroughfareNumber1Suffix?: string | null; /** @@ -5777,7 +5777,7 @@ export interface EnergyServicePointDetail { */ thoroughfareNumber2?: number | null; /** - * Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated + * Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated */ thoroughfareNumber2Suffix?: string | null; [k: string]: unknown; diff --git a/types/consumer-data-standards/package.json b/types/consumer-data-standards/package.json index 02953eb8bfc1f0e..f7f15c57545cc38 100644 --- a/types/consumer-data-standards/package.json +++ b/types/consumer-data-standards/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/consumer-data-standards", - "version": "7.2.9999", + "version": "7.3.9999", "nonNpm": true, "nonNpmDescription": "consumer-data-standards-browser", "projects": [ diff --git a/types/consumer-data-standards/register/index.d.ts b/types/consumer-data-standards/register/index.d.ts index 555f8695321053f..70c83c996608cb3 100644 --- a/types/consumer-data-standards/register/index.d.ts +++ b/types/consumer-data-standards/register/index.d.ts @@ -758,7 +758,7 @@ export interface ResponseOpenIDProviderConfigMetadata { */ jwks_uri: string; /** - * JSON array containing a list of the OAuth 2.0 response_type values that the CDR Registrer supports + * JSON array containing a list of the OAuth 2.0 response_type values that the CDR Register supports */ response_types_supported: string[]; /** diff --git a/types/conventional-changelog-core/conventional-changelog-core-tests.ts b/types/conventional-changelog-core/conventional-changelog-core-tests.ts index cf6ca158769be23..ebc5341db1dc464 100644 --- a/types/conventional-changelog-core/conventional-changelog-core-tests.ts +++ b/types/conventional-changelog-core/conventional-changelog-core-tests.ts @@ -2,7 +2,6 @@ "use strict"; import conventionalChangelogCore from "conventional-changelog-core"; -import gitRawCommits from "git-raw-commits"; namespace Module { declare const context: conventionalChangelogCore.Context; @@ -10,7 +9,6 @@ namespace Module { declare const options: conventionalChangelogCore.Options; declare const parserOpts: conventionalChangelogCore.ParserOptions; declare const writerOpts: conventionalChangelogCore.WriterOptions; - declare const execOpts: gitRawCommits.ExecOptions; // $ExpectType Readable conventionalChangelogCore(); // $ExpectType Readable @@ -23,6 +21,4 @@ namespace Module { conventionalChangelogCore(options, context, gitRawCommitsOpts, parserOpts); // $ExpectType Readable conventionalChangelogCore(options, context, gitRawCommitsOpts, parserOpts, writerOpts); - // $ExpectType Readable - conventionalChangelogCore(options, context, gitRawCommitsOpts, parserOpts, writerOpts, execOpts); } diff --git a/types/conventional-changelog-core/index.d.ts b/types/conventional-changelog-core/index.d.ts index 1127bc38245af14..565e117fd458865 100644 --- a/types/conventional-changelog-core/index.d.ts +++ b/types/conventional-changelog-core/index.d.ts @@ -4,7 +4,7 @@ import * as Stream from "stream"; import { Context as BaseContext, Options as BaseWriterOptions } from "conventional-changelog-writer"; import { Commit, Options as BaseParserOptions } from "conventional-commits-parser"; -import { ExecOptions as GitRawExecOptions, GitOptions as BaseGitRawCommitsOptions } from "git-raw-commits"; +import { GitOptions as BaseGitRawCommitsOptions } from "git-raw-commits"; import { Package } from "normalize-package-data"; @@ -23,7 +23,6 @@ declare function conventionalChangelogCore, - execOpts?: GitRawExecOptions, ): Stream.Readable; declare namespace conventionalChangelogCore { @@ -481,4 +480,4 @@ type ParserOptions = conventionalChangelogCore.ParserOptions; type WriterOptions = conventionalChangelogCore.WriterOptions; -export = conventionalChangelogCore; +export default conventionalChangelogCore; diff --git a/types/conventional-changelog-core/package.json b/types/conventional-changelog-core/package.json index ba23704510d203c..a0dbe583b0a3991 100644 --- a/types/conventional-changelog-core/package.json +++ b/types/conventional-changelog-core/package.json @@ -1,7 +1,8 @@ { "private": true, "name": "@types/conventional-changelog-core", - "version": "4.2.9999", + "type": "module", + "version": "8.0.9999", "projects": [ "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#readme" ], diff --git a/types/conventional-changelog-preset-loader/conventional-changelog-preset-loader-tests.ts b/types/conventional-changelog-preset-loader/conventional-changelog-preset-loader-tests.ts deleted file mode 100644 index 63cda15562d149c..000000000000000 --- a/types/conventional-changelog-preset-loader/conventional-changelog-preset-loader-tests.ts +++ /dev/null @@ -1,34 +0,0 @@ -/* tslint:disable:no-mergeable-namespace no-namespace */ - -import conventionalChangelogPresetLoader = require("conventional-changelog-preset-loader"); - -namespace Module { - declare const path: string; - declare const config: conventionalChangelogPresetLoader.Config; - - // $ExpectType Config - conventionalChangelogPresetLoader(path); - // $ExpectType Config - conventionalChangelogPresetLoader(config); - - // @ts-expect-error - conventionalChangelogPresetLoader(); -} - -namespace Module.presetLoader { - declare const require: conventionalChangelogPresetLoader.presetLoader.RequireMethod; - - // $ExpectType typeof conventionalChangelogPresetLoader - conventionalChangelogPresetLoader.presetLoader(require); - - // @ts-expect-error - conventionalChangelogPresetLoader.presetLoader(); -} - -namespace Module.Config { - declare const config: conventionalChangelogPresetLoader.Config; - - // $ExpectType Config - config; - config.name; // $ExpectType string -} diff --git a/types/conventional-changelog-preset-loader/index.d.ts b/types/conventional-changelog-preset-loader/index.d.ts deleted file mode 100644 index 2f97353c5eeaef2..000000000000000 --- a/types/conventional-changelog-preset-loader/index.d.ts +++ /dev/null @@ -1,50 +0,0 @@ -import { Options as CoreOptions } from "conventional-changelog-core"; -import { Context as WriterContext } from "conventional-changelog-writer"; -import { Commit } from "conventional-commits-parser"; - -/** - * The string that is passed to the preset loader is manipulated by prepending - * `conventional-changelog` to the name. - * - * For example: - * - * * `angular` => `conventional-changelog-angular` - * * `angular/preset/path` => `conventional-changelog-angular/preset/path` - * * `@scope/angular` => `@scope/conventional-changelog-angular` - * * `@scope/angular/preset/path` => `@scope/conventional-changelog-angular/preset/path` - * - * Will return whatever is exported by the preset package. That may be a - * configuration object, a function, or a promise. - * - * @param path - */ -declare function conventionalChangelogPresetLoader(path: string | Config): CoreOptions.Config; - -declare namespace conventionalChangelogPresetLoader { - function presetLoader(requireMethod: presetLoader.RequireMethod): typeof conventionalChangelogPresetLoader; - - namespace presetLoader { - type RequireMethod = (id: string) => any; - } - - type Builder = (config: CoreOptions.Config.Object & Config) => CoreOptions.Config; - - interface Config { - /** - * The string that is passed to the preset loader is manipulated by prepending - * `conventional-changelog` to the name. - * - * For example: - * - * * `angular` => `conventional-changelog-angular` - * * `angular/preset/path` => `conventional-changelog-angular/preset/path` - * * `@scope/angular` => `@scope/conventional-changelog-angular` - * * `@scope/angular/preset/path` => `@scope/conventional-changelog-angular/preset/path` - */ - name: string; - } -} - -type Config = conventionalChangelogPresetLoader.Config; - -export = conventionalChangelogPresetLoader; diff --git a/types/conventional-changelog-preset-loader/package.json b/types/conventional-changelog-preset-loader/package.json deleted file mode 100644 index 07b2ba7144a903f..000000000000000 --- a/types/conventional-changelog-preset-loader/package.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "private": true, - "name": "@types/conventional-changelog-preset-loader", - "version": "2.3.9999", - "projects": [ - "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-preset-loader#readme" - ], - "dependencies": { - "@types/conventional-changelog-core": "*", - "@types/conventional-changelog-writer": "*", - "@types/conventional-commits-parser": "*" - }, - "devDependencies": { - "@types/conventional-changelog-preset-loader": "workspace:." - }, - "owners": [ - { - "name": "Jason Kwok", - "githubUsername": "JasonHK" - } - ] -} diff --git a/types/conventional-changelog-preset-loader/tsconfig.json b/types/conventional-changelog-preset-loader/tsconfig.json deleted file mode 100644 index c0f15f71cfc0770..000000000000000 --- a/types/conventional-changelog-preset-loader/tsconfig.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "compilerOptions": { - "module": "node16", - "lib": [ - "es6" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictFunctionTypes": true, - "strictNullChecks": true, - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "conventional-changelog-preset-loader-tests.ts" - ] -} diff --git a/types/conventional-changelog/index.d.ts b/types/conventional-changelog/index.d.ts index f283b9ca73f9f34..aa279682da6f07a 100644 --- a/types/conventional-changelog/index.d.ts +++ b/types/conventional-changelog/index.d.ts @@ -1,16 +1,9 @@ /// -import * as Stream from "stream"; - -import { - Context, - GitRawCommitsOptions, - Options as BaseOptions, - ParserOptions, - WriterOptions, -} from "conventional-changelog-core"; +import conventionalChangelogCore from "conventional-changelog-core"; import { Context as WriterContext } from "conventional-changelog-writer"; import { Commit } from "conventional-commits-parser"; +import * as Stream from "stream"; /** * Returns a readable stream. @@ -21,12 +14,15 @@ import { Commit } from "conventional-commits-parser"; * @param parserOpts * @param writerOpts */ -declare function conventionalChangelog( +declare function conventionalChangelog< + TCommit extends Commit = Commit, + TContext extends WriterContext = conventionalChangelogCore.Context, +>( options?: Options, context?: Partial, - gitRawCommitsOpts?: GitRawCommitsOptions, - parserOpts?: ParserOptions, - writerOpts?: WriterOptions, + gitRawCommitsOpts?: conventionalChangelogCore.GitRawCommitsOptions, + parserOpts?: conventionalChangelogCore.ParserOptions, + writerOpts?: conventionalChangelogCore.WriterOptions, ): Stream.Readable; declare namespace conventionalChangelog { @@ -35,7 +31,7 @@ declare namespace conventionalChangelog { * docs. The API is the same with the following changes or additions: */ interface Options - extends BaseOptions + extends conventionalChangelogCore.Options { /** * It's recommended to use a preset so you don't have to define everything @@ -55,4 +51,4 @@ declare namespace conventionalChangelog { type Options = conventionalChangelog.Options; -export = conventionalChangelog; +export default conventionalChangelog; diff --git a/types/conventional-changelog/package.json b/types/conventional-changelog/package.json index 331a7efe30fbeb2..fe47d9aaee0d829 100644 --- a/types/conventional-changelog/package.json +++ b/types/conventional-changelog/package.json @@ -1,7 +1,8 @@ { "private": true, "name": "@types/conventional-changelog", - "version": "3.1.9999", + "type": "module", + "version": "6.0.9999", "projects": [ "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog#readme" ], diff --git a/types/cordova-plugin-qrscanner/package.json b/types/cordova-plugin-qrscanner/package.json index 470a2c42e1f0954..709848d8143fc6d 100644 --- a/types/cordova-plugin-qrscanner/package.json +++ b/types/cordova-plugin-qrscanner/package.json @@ -12,10 +12,6 @@ { "name": "Jason Dreyzehner", "githubUsername": "bitjson" - }, - { - "name": "Josh Bronson", - "githubUsername": "jab" } ] } diff --git a/types/css-tree/css-tree-tests.ts b/types/css-tree/css-tree-tests.ts index 0e6daed00db146d..8b01356e5a0a2f6 100644 --- a/types/css-tree/css-tree-tests.ts +++ b/types/css-tree/css-tree-tests.ts @@ -749,3 +749,5 @@ lexer.match("foo", ast); // $ExpectType LexerMatchResult lexer.match("foo", "bar"); // $ExpectType LexerMatchResult lexer.match(syntax, ast); // $ExpectType LexerMatchResult lexer.match(syntax, "bar"); // $ExpectType LexerMatchResult + +csstree.lexer; // $ExpectType Lexer diff --git a/types/css-tree/index.d.ts b/types/css-tree/index.d.ts index e5aa5ace3544213..b9c1d73c92738d2 100644 --- a/types/css-tree/index.d.ts +++ b/types/css-tree/index.d.ts @@ -907,6 +907,8 @@ export class Lexer { match(syntax: DSNode | string, value: CssNode | string): LexerMatchResult; } +export const lexer: Lexer; + export function fork(extension: { atrules?: Record | undefined; properties?: Record | undefined; diff --git a/types/cytoscape/package.json b/types/cytoscape/package.json index c3eebc53e0a1986..63c2b17fe8f2945 100644 --- a/types/cytoscape/package.json +++ b/types/cytoscape/package.json @@ -13,10 +13,6 @@ "name": " Fabian Schmidt and Fred Eisele", "githubUsername": "phreed" }, - { - "name": "Shenghan Gao", - "githubUsername": "wy193777" - }, { "name": "Yuri Pereira Constante", "githubUsername": "ypconstante" diff --git a/types/d3-shape/d3-shape-tests.ts b/types/d3-shape/d3-shape-tests.ts index 4c6c3d13c676938..01cb912aab54d9d 100644 --- a/types/d3-shape/d3-shape-tests.ts +++ b/types/d3-shape/d3-shape-tests.ts @@ -1435,6 +1435,7 @@ customSymbol = d3Shape.symbolTriangle; customSymbol = d3Shape.symbolTriangle2; customSymbol = d3Shape.symbolWye; customSymbol = d3Shape.symbolX; +customSymbol = d3Shape.symbolTimes; // ----------------------------------------------------------------------------------- // Test pointRadial diff --git a/types/d3-shape/index.d.ts b/types/d3-shape/index.d.ts index 6ce55c42bc1a10c..1ef05584c3c1f4e 100644 --- a/types/d3-shape/index.d.ts +++ b/types/d3-shape/index.d.ts @@ -2394,6 +2394,11 @@ export const symbolWye: SymbolType; */ export const symbolX: SymbolType; +/** + * The X-shape symbol type; intended for stroking. + */ +export const symbolTimes: SymbolType; + // ----------------------------------------------------------------------------------- // pointRadial // ----------------------------------------------------------------------------------- diff --git a/types/dateformat/package.json b/types/dateformat/package.json index 3605aef4ed06f7a..e3f4090fafe663a 100644 --- a/types/dateformat/package.json +++ b/types/dateformat/package.json @@ -2,6 +2,7 @@ "private": true, "name": "@types/dateformat", "version": "5.0.9999", + "type": "module", "projects": [ "https://github.com/felixge/node-dateformat" ], diff --git a/types/deep-equal-in-any-order/deep-equal-in-any-order-tests.ts b/types/deep-equal-in-any-order/deep-equal-in-any-order-tests.ts index cf1ad37797acea8..8087d3cfca19061 100644 --- a/types/deep-equal-in-any-order/deep-equal-in-any-order-tests.ts +++ b/types/deep-equal-in-any-order/deep-equal-in-any-order-tests.ts @@ -1,6 +1,7 @@ import deepEqualInAnyOrder = require("deep-equal-in-any-order"); declare const expect: Chai.ExpectStatic; +declare const assert: Chai.AssertStatic; import("chai").then(({ use }) => use(deepEqualInAnyOrder)); @@ -12,3 +13,12 @@ expect({ foo: [1, 2], bar: { baz: ["a", "b", { lorem: [5, 6] }] } }).to.deep.equ foo: [2, 1], bar: { baz: ["b", "a", { lorem: [6, 5] }] }, }); + +assert.deepEqualInAnyOrder([1, 2], [2, 1]); +assert.notDeepEqualInAnyOrder([1, 2], [2, 1, 3]); +assert.deepEqualInAnyOrder({ foo: [1, 2], bar: [4, 89, 22] }, { foo: [2, 1], bar: [4, 22, 89] }); +assert.deepEqualInAnyOrder({ foo: ["foo-1", "foo-2", [1, 2], null] }, { foo: [null, [1, 2], "foo-1", "foo-2"] }); +assert.deepEqualInAnyOrder({ foo: [1, 2], bar: { baz: ["a", "b", { lorem: [5, 6] }] } }, { + foo: [2, 1], + bar: { baz: ["b", "a", { lorem: [6, 5] }] }, +}); diff --git a/types/deep-equal-in-any-order/index.d.ts b/types/deep-equal-in-any-order/index.d.ts index 878587b87029fb1..24a8d2d24a72081 100644 --- a/types/deep-equal-in-any-order/index.d.ts +++ b/types/deep-equal-in-any-order/index.d.ts @@ -6,5 +6,33 @@ declare global { } } +declare global { + namespace Chai { + interface Assert { + /** + * It works in similar way as deepEqual but it doesn’t checks the arrays order (at any level of nested objects and arrays). + * The array elements can be any JS entity (boolean, null, number, string, object, array…). + * + * T Type of the objects. + * @param actual Actual value. + * @param expected Potential expected value. + * @param message Message to display on error. + */ + deepEqualInAnyOrder: (actual: T, expected: T, message?: string) => void; + + /** + * It works in similar way as notDeepEqual but it doesn’t checks the arrays order (at any level of nested objects and arrays). + * The array elements can be any JS entity (boolean, null, number, string, object, array…). + * + * T Type of the objects. + * @param actual Actual value. + * @param expected Potential expected value. + * @param message Message to display on error. + */ + notDeepEqualInAnyOrder: (actual: T, expected: T, message?: string) => void; + } + } +} + declare const deepEqualInAnyOrder: Chai.ChaiPlugin; export = deepEqualInAnyOrder; diff --git a/types/diff/diff-tests.ts b/types/diff/diff-tests.ts index 132f99fc14e72b8..bd1db9d3042bf25 100644 --- a/types/diff/diff-tests.ts +++ b/types/diff/diff-tests.ts @@ -24,6 +24,7 @@ Diff.diffLines( "line\nold value\nline", "line\nnew value\nline", { + stripTrailingCr: true, ignoreNewlineAtEof: true, maxEditLength: 1, oneChangePerToken: true, @@ -93,6 +94,7 @@ function verifyPatchMethods(oldStr: string, newStr: string, uniDiff: Diff.Parsed const verifyPatch = Diff.parsePatch( Diff.createTwoFilesPatch("oldFile.ts", "newFile.ts", oldStr, newStr, "old", "new", { context: 1, + stripTrailingCr: true, }), ); diff --git a/types/diff/index.d.ts b/types/diff/index.d.ts index 3973978d4c61b60..93edd6c3c4b3c96 100644 --- a/types/diff/index.d.ts +++ b/types/diff/index.d.ts @@ -61,6 +61,11 @@ export interface LinesOptions extends BaseOptions { * friendly output. */ newlineIsToken?: boolean | undefined; + + /** + * `true` to remove all trailing CR (`\r`) characters before performing the diff. Defaults to false. This helps to get a useful diff when diffing UNIX text files against Windows text files. + */ + stripTrailingCr?: boolean | undefined; } export interface JsonOptions extends LinesOptions { diff --git a/types/diff/package.json b/types/diff/package.json index 3db26f30c038822..382bbc259698fe5 100644 --- a/types/diff/package.json +++ b/types/diff/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/diff", - "version": "6.0.9999", + "version": "7.0.9999", "projects": [ "https://github.com/kpdecker/jsdiff" ], diff --git a/types/dockerode/dockerode-tests.ts b/types/dockerode/dockerode-tests.ts index e70754ce3c4cfd2..e980f3061d1eafa 100644 --- a/types/dockerode/dockerode-tests.ts +++ b/types/dockerode/dockerode-tests.ts @@ -147,6 +147,18 @@ container.start((err, data) => { // NOOP }); +container.exec({ + Cmd: ["echo", "hello"], + AttachStdin: true, + AttachStdout: true, + AttachStderr: true, + Tty: true, + User: "root", + ConsoleSize: [80, 24], +}, (err, data) => { + // NOOP +}); + container.remove((err, data) => { // NOOP }); @@ -382,6 +394,14 @@ docker.createVolume({ Name: "volumeName" }, (err, volume) => { volume.remove({ abortSignal: new AbortController().signal }, (err, data) => { // NOOP }); + + volume.remove({ force: true }, (err, data) => { + // NOOP + }); + + volume.remove({ force: true, abortSignal: new AbortController().signal }, (err, data) => { + // NOOP + }); }); docker.createNetwork({ Name: "networkName" }).then(network => { diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 30619fef4bc78f6..a4eb03a06e56881 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -473,6 +473,7 @@ declare namespace Dockerode { interface VolumeRemoveOptions { abortSignal?: AbortSignal; + force?: boolean | undefined; } interface VolumeCreateResponse { @@ -1107,6 +1108,7 @@ declare namespace Dockerode { User?: string | undefined; WorkingDir?: string | undefined; abortSignal?: AbortSignal; + ConsoleSize?: [number, number]; } interface ExecInspectInfo { diff --git a/types/domhandler/domhandler-tests.ts b/types/domhandler/domhandler-tests.ts deleted file mode 100644 index 0e46742de43fc65..000000000000000 --- a/types/domhandler/domhandler-tests.ts +++ /dev/null @@ -1,28 +0,0 @@ -import { DomElement, DomHandler, DomHandlerOptions, Node } from "domhandler"; - -const handler = new DomHandler((error: Error, dom: DomElement[]) => { - if (error) { - console.error("There has been an error..."); - } else { - console.log(dom); - } -}); -handler.ontext = (data: string) => { - console.log(data); -}; -handler.onreset = () => { - console.log("We have a reset."); -}; -handler.onerror = (error: Error) => { - console.error(error); -}; -handler.onopentag = (name: string, attribs: { [s: string]: string }) => { - console.log(name, attribs); -}; - -const dho: DomHandlerOptions = { - normalizeWhitespace: true, - withDomLvl1: true, - withEndIndices: true, - withStartIndices: true, -}; diff --git a/types/domhandler/index.d.ts b/types/domhandler/index.d.ts deleted file mode 100644 index 4f688f25743212b..000000000000000 --- a/types/domhandler/index.d.ts +++ /dev/null @@ -1,73 +0,0 @@ -export interface DomHandlerOptions { - /*** - * Indicates whether the whitespace in text nodes should be normalized - * (= all whitespace should be replaced with single spaces). The default value is "false". - */ - normalizeWhitespace?: boolean | undefined; - - /*** - * Adds DOM level 1 properties to all elements. - */ - withDomLvl1?: boolean | undefined; - - /*** - * Indicates whether a startIndex property will be added to nodes. - * When the parser is used in a non-streaming fashion, startIndex is an integer - * indicating the position of the start of the node in the document. - * The default value is "false". - */ - withStartIndices?: boolean | undefined; - - /*** - * Indicates whether a endIndex property will be added to nodes. - * When the parser is used in a non-streaming fashion, endIndex is an integer - * indicating the position of the end of the node in the document. - * The default value is "false". - */ - withEndIndices?: boolean | undefined; -} - -export interface DomElement { - attribs?: { [s: string]: string } | undefined; - children?: DomElement[] | undefined; - data?: any; - name?: string | undefined; - next?: DomElement | undefined; - parent?: DomElement | undefined; - prev?: DomElement | undefined; - type?: string | undefined; -} - -export interface Element extends DomElement { - name: string; -} - -export interface Node extends DomElement { - readonly firstChild: DomElement; - readonly lastChild: DomElement; - readonly nodeType: number; -} - -export class DomHandler { - constructor(callback: (error: any, dom: DomElement[]) => any, options?: DomHandlerOptions); - - onparserinit(parser: any): void; - - /*** - * Resets the handler back to starting state - */ - onreset(): void; - - /*** - * Signals the handler that parsing is done - */ - onend(): void; - onerror(error: Error): void; - onclosetag(): void; - onopentag(name: string, attribs: { [s: string]: string }): void; - ontext(data: string): void; - oncomment(data: string): void; - oncdatastart(): void; - oncommentend(): void; - onprocessinginstruction(name: string, data: string): void; -} diff --git a/types/domhandler/package.json b/types/domhandler/package.json deleted file mode 100644 index 568ad21df281f9e..000000000000000 --- a/types/domhandler/package.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "private": true, - "name": "@types/domhandler", - "version": "2.4.9999", - "projects": [ - "https://github.com/fb55/DomHandler#readme" - ], - "devDependencies": { - "@types/domhandler": "workspace:." - }, - "owners": [ - { - "name": "Johan Davidsson", - "githubUsername": "johandavidson" - } - ] -} diff --git a/types/earcut/earcut-tests.ts b/types/earcut/earcut-tests.ts index 83fdd1110c3ce44..48dcfc21c0171eb 100644 --- a/types/earcut/earcut-tests.ts +++ b/types/earcut/earcut-tests.ts @@ -1,3 +1,5 @@ +import { default as earcut, deviation, flatten } from "earcut"; + const a = earcut([10, 0, 0, 50, 60, 60, 70, 10]); // @example with a hole: const b = earcut([0, 0, 100, 0, 100, 100, 0, 100, 20, 20, 80, 20, 80, 80, 20, 80], [4]); // [3,0,4, 5,4,0, 3,4,7, 5,0,1, 2,3,7, 6,5,1, 2,7,6, 6,1,2] @@ -8,9 +10,9 @@ declare const vertices: number[]; declare const holes: number[]; declare const dimensions: number; const triangles = earcut(vertices, holes, dimensions); -const deviation = earcut.deviation(vertices, holes, dimensions, triangles); +const deviationResult = deviation(vertices, holes, dimensions, triangles); -const data = earcut.flatten([[[0, 0], [100, 0], [0, 100]], [[10, 10], [0, 10], [10, 0]]]); +const data = flatten([[[0, 0], [100, 0], [0, 100]], [[10, 10], [0, 10], [10, 0]]]); const triangles2 = earcut(data.vertices, data.holes, data.dimensions); declare const multiDimData: number[][][]; diff --git a/types/earcut/index.d.ts b/types/earcut/index.d.ts index e46e71999c80a7f..bbae1522435bbfa 100644 --- a/types/earcut/index.d.ts +++ b/types/earcut/index.d.ts @@ -1,48 +1,44 @@ -interface EarcutStatic { - /** - * Triangulate an outline. - * - * @param vertices A flat array of vertice coordinates like [x0,y0, x1,y1, x2,y2, ...]. - * @param holes An array of hole indices if any (e.g. [5, 8] for a 12-vertice input would mean one hole with vertices 5–7 and another with 8–11). - * @param dimensions The number of coordinates per vertice in the input array (2 by default). - * @return A flat array with each group of three numbers indexing a triangle in the `vertices` array. - * @example earcut([10,0, 0,50, 60,60, 70,10]); // returns [1,0,3, 3,2,1] - * @example with a hole: earcut([0,0, 100,0, 100,100, 0,100, 20,20, 80,20, 80,80, 20,80], [4]); // [3,0,4, 5,4,0, 3,4,7, 5,0,1, 2,3,7, 6,5,1, 2,7,6, 6,1,2] - * @example with 3d coords: earcut([10,0,1, 0,50,2, 60,60,3, 70,10,4], null, 3); // [1,0,3, 3,2,1] - */ - (vertices: ArrayLike, holes?: ArrayLike, dimensions?: number): number[]; +/** + * Triangulate an outline. + * + * @param vertices A flat array of vertice coordinates like [x0,y0, x1,y1, x2,y2, ...]. + * @param holes An array of hole indices if any (e.g. [5, 8] for a 12-vertice input would mean one hole with vertices 5–7 and another with 8–11). + * @param dimensions The number of coordinates per vertice in the input array (2 by default). + * @return A flat array with each group of three numbers indexing a triangle in the `vertices` array. + * @example earcut([10,0, 0,50, 60,60, 70,10]); // returns [1,0,3, 3,2,1] + * @example with a hole: earcut([0,0, 100,0, 100,100, 0,100, 20,20, 80,20, 80,80, 20,80], [4]); // [3,0,4, 5,4,0, 3,4,7, 5,0,1, 2,3,7, 6,5,1, 2,7,6, 6,1,2] + * @example with 3d coords: earcut([10,0,1, 0,50,2, 60,60,3, 70,10,4], null, 3); // [1,0,3, 3,2,1] + */ +export default function earcut(vertices: ArrayLike, holes?: ArrayLike, dimensions?: number): number[]; - /** - * Transforms multi-dimensional array (e.g. GeoJSON Polygon) into the format expected by earcut. - * @example Transforming GeoJSON data. - * const data = earcut.flatten(geojson.geometry.coordinates); - * const triangles = earcut(data.vertices, data.holes, data.dimensions); - * @example Transforming simple triangle with hole: - * const data = earcut.flatten([[[0, 0], [100, 0], [0, 100]], [[10, 10], [0, 10], [10, 0]]]); - * const triangles = earcut(data.vertices, data.holes, data.dimensions); - * @param data Arrays of rings, with the first being the outline and the rest holes. A ring is an array points, each point being an array of numbers. - */ - flatten(data: ArrayLike>>): { vertices: number[]; holes: number[]; dimensions: number }; +/** + * Transforms multi-dimensional array (e.g. GeoJSON Polygon) into the format expected by earcut. + * @example Transforming GeoJSON data. + * const data = earcut.flatten(geojson.geometry.coordinates); + * const triangles = earcut(data.vertices, data.holes, data.dimensions); + * @example Transforming simple triangle with hole: + * const data = earcut.flatten([[[0, 0], [100, 0], [0, 100]], [[10, 10], [0, 10], [10, 0]]]); + * const triangles = earcut(data.vertices, data.holes, data.dimensions); + * @param data Arrays of rings, with the first being the outline and the rest holes. A ring is an array points, each point being an array of numbers. + */ +export function flatten( + data: ArrayLike>>, +): { vertices: number[]; holes: number[]; dimensions: number }; - /** - * Returns the relative difference between the total area of triangles and the area of the input polygon. 0 means the triangulation is fully correct. - * @param vertices same as earcut - * @param holes same as earcut - * @param dimensions same as earcut - * @param triangles see return value of earcut - * @example - * const triangles = earcut(vertices, holes, dimensions); - * const deviation = earcut.deviation(vertices, holes, dimensions, triangles); - */ - deviation( - vertices: ArrayLike, - holes: ArrayLike | undefined, - dimensions: number, - triangles: ArrayLike, - ): number; - - default: EarcutStatic; -} -declare const exports: EarcutStatic; -export = exports; -export as namespace earcut; +/** + * Returns the relative difference between the total area of triangles and the area of the input polygon. 0 means the triangulation is fully correct. + * Used to verify correctness of triangulation + * @param vertices same as earcut + * @param holes same as earcut + * @param dimensions same as earcut + * @param triangles see return value of earcut + * @example + * const triangles = earcut(vertices, holes, dimensions); + * const deviation = earcut.deviation(vertices, holes, dimensions, triangles); + */ +export function deviation( + vertices: ArrayLike, + holes: ArrayLike | undefined, + dimensions: number, + triangles: ArrayLike, +): number; diff --git a/types/earcut/package.json b/types/earcut/package.json index 9cc11a0c39533c8..3399eb2401d664f 100644 --- a/types/earcut/package.json +++ b/types/earcut/package.json @@ -1,7 +1,8 @@ { "private": true, "name": "@types/earcut", - "version": "2.1.9999", + "type": "module", + "version": "3.0.9999", "projects": [ "https://github.com/mapbox/earcut#readme" ], diff --git a/types/echarts/.eslintrc.json b/types/echarts/.eslintrc.json deleted file mode 100644 index 1c3f230906d8c0b..000000000000000 --- a/types/echarts/.eslintrc.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "rules": { - "@definitelytyped/no-declare-current-package": "off", - "@typescript-eslint/no-unsafe-function-type": "off", - "@typescript-eslint/no-wrapper-object-types": "off", - "@typescript-eslint/consistent-type-definitions": "off", - "@typescript-eslint/no-invalid-void-type": "off" - } -} diff --git a/types/echarts/echarts-tests.ts b/types/echarts/echarts-tests.ts deleted file mode 100644 index f14fe62bce035e7..000000000000000 --- a/types/echarts/echarts-tests.ts +++ /dev/null @@ -1,42 +0,0 @@ -import * as echarts from "echarts"; - -const option: echarts.EChartOption = { - series: [], - title: { - padding: 5, - }, -}; - -const testChartTitlePadding = (options: echarts.EChartTitleOption) => { - options.padding = 5; - options.padding = [5]; - options.padding = [5, 10]; - options.padding = [5, 10, 15]; - options.padding = [5, 10, 15, 20]; -}; - -const testAxisLabelColor = (options: echarts.EChartOption.XAxis) => { - options.axisLabel = { - color: "red", - }; - options.axisLabel = { - color: (val: string) => { - if (val === "300") { - return "red"; - } else { - return "blue"; - } - }, - }; -}; - -// id, type, and name are defined for every series type -const map = option.series!.map(s => [s.id, s.name, s.type]); - -const seriesGraph: echarts.EChartOption.SeriesGraph = {}; -// $ExpectType number | number[] | undefined -seriesGraph.autoCurveness; -seriesGraph.autoCurveness = 10; -seriesGraph.autoCurveness = [1, 2, 3, 4]; -// @ts-expect-error -seriesGraph.autoCurveness = "error"; diff --git a/types/echarts/index.d.ts b/types/echarts/index.d.ts deleted file mode 100644 index 5c451eba81b1753..000000000000000 --- a/types/echarts/index.d.ts +++ /dev/null @@ -1,1735 +0,0 @@ -/// -/// - -declare namespace echarts { - /** - * Creates an ECharts instance, and returns an echartsInstance. You shall - * not initialize multiple ECharts instances on a single container. - * - * @param {HTMLDivElement | HTMLCanvasElement} dom Instance container, - * usually is a `div` element with height and width defined. - * @param {object | string} [theme] Theme to be applied. - * This can be a configuring object of a theme, or a theme name - * registered through [echarts.registerTheme](https://echarts.apache.org/api.html#echarts.registerTheme). - * @param {object} [opts] Chart configurations. - * @param {number} [opts.devicePixelRatio] Ratio of one physical pixel to - * the size of one device independent pixels. Browser's - * `window.devicePixelRatio` is used by default. - * @param {string} [opts.renderer] Supports `'canvas'` or `'svg'`. - * See [Render by Canvas or SVG](https://echarts.apache.org/tutorial.html#Render%20by%20Canvas%20or%20SVG). - * @param {number} [opts.width] Specify width explicitly, in pixel. - * If setting to `null`/`undefined`/`'auto'`, width of `dom` - * (instance container) will be used. - * @param {number} [opts.height] Specify height explicitly, in pixel. - * If setting to `null`/`undefined`/`'auto'`, height of `dom` - * (instance container) will be used. - */ - function init( - dom: HTMLDivElement | HTMLCanvasElement, - theme?: object | string, - opts?: { - devicePixelRatio?: number | undefined; - renderer?: string | undefined; - width?: number | string | undefined; - height?: number | string | undefined; - }, - ): ECharts; - - /** - * Connects interaction of multiple chart series. For example: - * - ```js - // set group id of each instance respectively. - chart1.group = 'group1'; - chart2.group = 'group1'; - echarts.connect('group1'); - // or incoming instance array that need to be linked. - echarts.connect([chart1, chart2]); - ``` - * - * @param group Group id in string, or array of chart instance. - */ - function connect(group: string | ECharts[]): void; - - /** - * Disconnects interaction of multiple chart series. To have one single - * instance to be removed, you can set `group` of chart instance to be null. - * - * @param {string} group Group id in string. - */ - function disConnect(group: string): void; - - /** - * Destroys chart instance, after which the instance cannot be used any - * more. - * - * @param target Chart instance or container. - */ - function dispose(target: ECharts | HTMLDivElement | HTMLCanvasElement): void; - - /** - * Returns chart instance of dom container. - * - * @param target Chart container. - */ - function getInstanceByDom(target: HTMLDivElement | HTMLCanvasElement): ECharts; - - /** - * Registers available maps. This can only be used after including - * [geo](https://echarts.apache.org/option.html#geo) - * component or chart series of - * [map](https://echarts.apache.org/option.html#series-map). - * - * @param {string} mapName Map name, referring to `map` value set in - * [geo](https://echarts.apache.org/option.html#geo) - * component or - * [map](https://echarts.apache.org/option.html#series-map). - * @param {object} geoJson Data in GeoJson format. See - * [http://geojson.org/](http://geojson.org/) for more format information. - * @param {object} [specialAreas] Zoomed part of a specific area in the map - * for better visual effect. - * See [USA Population Estimates example](https://echarts.apache.org/examples/en/editor.html?c=map-usa). - */ - function registerMap(mapName: string, geoJson: object, specialAreas?: object): void; - - /** - * Registers a theme, should be specified when - * [initialize the chart instance](https://echarts.apache.org/api.html#echarts.init). - * - * @param {string} themeName Theme name. - * @param {object} theme Theme configurations. - */ - function registerTheme(themeName: string, theme: object): void; - - interface MapObj { - /** - * geoJson data for map - */ - geoJson: object; - /** - * special areas fro map - */ - specialAreas: object; - } - - /** - * Get a registed map. - * - * @param {string} mapName Map name. - * @return {MapObj} Map data. - */ - function getMap(mapName: string): MapObj; - - /** - * Util methods about graphics. - */ - const graphic: Graphic; - - interface Graphic { - /** - * x, y, x2, y2 are all percent from 0 to 1 - */ - LinearGradient: zrender.LinearGradient; - - /** - * Create a new shape class. - * - * @param {number[][]} opt - * @return {zrender.graphic.Path} - */ - extendShape(opt: zrender.graphic.Path): zrender.graphic.Path; - - /** - * Register a user defined shape. - * - * @param {string} name - * @param {zrender.graphic.Path} ShapeClass - */ - registerShape(name: string, ShapeClass: zrender.graphic.Path): void; - - /** - * Get the registered shape class. - * - * @param {string} name - * @return {zrender.graphic.Path} - */ - getShapeClass(name: string): zrender.graphic.Path; - - /** - * Clip the given points by the given rectangular. - * - * @param {number[][]} points The points to be clipped, - * like [[23, 44], [12, 15], ...]. - * @param {ERectangle} rect The rectangular that is used to clip points. - */ - clipPointsByRect(points: number[][], rect: ERectangle): number[][]; - - /** - * Clip the first input rectangular by the second input rectangular. - * - * @param {ERectangle} targetRect The rectangular to be clipped. - * @param {ERectangle} rect The rectangular that is used to clip - * targetRect. - */ - clipRectByRect(targetRect: ERectangle, rect: ERectangle): ERectangle; - } - - interface ECharts { - /** - * Group name to be used in chart connection - */ - group: string; - - /** - * Configuration item, data, universal interface, all parameters and - * data can all be modified through `setOption`. ECharts will merge - * new parameters and data, and then refresh chart. - * - * @param {EChartOption} option Configuration item and data. Please - * refer to [configuration item manual](https://echarts.apache.org/option.html) - * for more information. - * @param {boolean} [notMerge=false] Whether not to merge with previous - * `option` - * @param {boolean} [lazyUpdate=false] Whether not to update chart - * immediately - */ - setOption(option: EChartOption | EChartsResponsiveOption, notMerge?: boolean, lazyUpdate?: boolean): void; - - /** - * Configuration item, data, universal interface, all parameters and - * data can all be modified through `setOption`. ECharts will merge - * new parameters and data, and then refresh chart. - * - * @param {EChartOption} option Configuration item and data. Please - * refer to [configuration item manual](https://echarts.apache.org/option.html) - * for more information. - * @param {EChartsOptionConfig} [opts] Options about how to setOption - */ - setOption(option: EChartOption, opts?: EChartsOptionConfig): void; - - /** - * Gets width of ECharts instance container. - * - * @return {number} Width. - */ - getWidth(): number; - - /** - * Gets height of ECharts instance container. - * - * @return {number} Height. - */ - getHeight(): number; - - /** - * Gets DOM element of ECharts instance container. - * - * @return {HTMLCanvasElement|HTMLDivElement} DOM container. - */ - getDom(): HTMLCanvasElement | HTMLDivElement; - - /** - * Gets `option` object maintained in current instance, which contains - * configuration item and data merged from previous `setOption` - * operations by users, along with user interaction states. - * For example, switching of legend, zooming area of data zoom, - * and so on. Therefore, a new instance that is exactly the same - * can be recovered from this option. - */ - getOption(): EChartOption; - - /** - * Resizes chart, which should be called manually when container size - * changes. When `opts` is not provided, DOM size is used. - * - * @param {EChartsResizeOption} opts Specify parameters explicitly. - */ - resize(opts?: EChartsResizeOption): void; - - /** - * Triggers chart action, like chart switch `legendToggleSelect`, - * zoom data area `dataZoom`, show tooltip `showTip` and so on. - * See [action](https://echarts.apache.org/api.html#action) and - * [events](https://echarts.apache.org/api.html#events) - * for more information. - * - * @param payload Trigger multiple actions through `batch` attribute. - */ - dispatchAction(payload: object): void; - - /** - * Binds event-handling function. - * There are two kinds of events in ECharts, one of which is mouse - * events, which will be triggered when the mouse clicks certain - * element in the chart, the other kind will be triggered after - * `dispatchAction` is called. Every action has a corresponding - * event. - * If event is triggered externally by `dispatchAction`, and there - * is batch attribute in action to trigger batch action, then the - * corresponding response event parameters be in batch. - * - * @param {string} eventName Event names are all in lower-cases, - * for example, `'click'`, `'mousemove'`, `'legendselected'` - * @param {Function} handler Event-handling function, whose format - * is as following: - ```js - (event: object) - ``` - * @param {object} [context] context of callback function, what - * `this` refers to. - */ - on(eventName: string, handler: Function, context?: object): void; - - /** - * Binds event-handling function. - * There are two kinds of events in ECharts, one of which is mouse - * events, which will be triggered when the mouse clicks certain - * element in the chart, the other kind will be triggered after - * `dispatchAction` is called. Every action has a corresponding - * event. - * If event is triggered externally by `dispatchAction`, and there - * is batch attribute in action to trigger batch action, then the - * corresponding response event parameters be in batch. - * - * @param {string} eventName Event names are all in lower-cases, - * for example, `'click'`, `'mousemove'`, `'legendselected'` - * @param {string | Object} query Condition for filtering, optional. - * `query` enables only call handlers on graphic elements of - * specified components. Can be `string` or `Object`. - * If `string`, the formatter can be 'mainType' or 'mainType.subType'. - * For example: - * ```ts - * chart.on('click', 'series', function () {...}); - * chart.on('click', 'series.line', function () {...}); - * chart.on('click', 'dataZoom', function () {...}); - * chart.on('click', 'xAxis.category', function () {...}); - * ``` - * If `Object`, one or more properties below can be included, - * and any of them is optional. - * ```ts - * { - * Index: number // component index - * Name: string // component name - * Id: string // component id - * dataIndex: number // data item index - * name: string // data item name - * dataType: string // data item type, e.g., - * // 'node' and 'edge' in graph. - * element: string // element name in custom series - * } - * ``` - * For example: - * ```ts - * chart.setOption({ - * // ... - * series: [{ - * name: 'uuu' - * // ... - * }] - * }); - * chart.on('mouseover', {seriesName: 'uuu'}, function () { - * // When the graphic elements in the series with name 'uuu' mouse - * // overed, this method is called. - * }); - * ``` - * For example: - * ```ts - * chart.setOption({ - * // ... - * series: [{ - * type: 'graph', - * nodes: [{name: 'a', value: 10}, {name: 'b', value: 20}], - * edges: [{source: 0, target: 1}] - * }] - * }); - * chart.on('click', {dataType: 'node'}, function () { - * // When the nodes of the graph clicked, this method is called. - * }); - * chart.on('click', {dataType: 'edge'}, function () { - * // When the edges of the graph clicked, this method is called. - * }); - * ``` - * For example - * ```ts - * chart.setOption({ - * // ... - * series: { - * // ... - * type: 'custom', - * renderItem: function (params, api) { - * return { - * type: 'group', - * children: [{ - * type: 'circle', - * name: 'my_el', - * // ... - * }, { - * // ... - * }] - * } - * }, - * data: [[12, 33]] - * } - * }) - * chart.on('click', {targetName: 'my_el'}, function () { - * // When the element with name 'my_el' clicked, this method is called. - * }); - * ``` - * @param {Function} handler Event-handling function, whose format - * is as following: - ```js - (event: object) - ``` - * @param {object} [context] context of callback function, what - * `this` refers to. - */ - on(eventName: string, query: string | Object, handler: Function, context?: object): void; - - /** - * Unbind event-handler function. - * - * @param {string} eventName Event names are all in lower-cases, - * for example, `'click'`, `'mousemove'`, `'legendselected'` - * @param {Function} [handler] The function to be unbound could be - * passed. Otherwise, all event functions of this type will be - * unbound. - */ - off(eventName: string, handler?: Function): void; - - /** - * Convert a point from logical coordinate (e.g., in geo, cartesian, - * graph, ...) to pixel coordinate. - * - * @param {EChartsConvertFinder} finder Indicate in which coordinate - * system conversion is performed. - * Generally, index or id or name can be used to specify - * coordinate system. - * @param {string | any[]} value The value to be converted. - */ - convertToPixel(finder: EChartsConvertFinder, value: string | any[]): string | any[]; - - /** - * Convert a point from pixel coordinate to logical coordinate - * (e.g., in geo, cartesian, graph, ...). - * - * @param {EChartsConvertFinder} finder Indicate in which coordinate - * system conversion is performed. - * Generally, index or id or name can be used to specify - * coordinate system. - * @param {string | any[]} value The value to be converted. - */ - convertFromPixel(finder: EChartsConvertFinder, value: any[] | string): any[] | string; - - /** - * Determine whether the given point is in the given coordinate systems or series. - * - * @param {EChartsConvertFinder} finder Indicate in which coordinate - * system conversion is performed. - * Generally, index or id or name can be used to specify - * coordinate system. - * @param {string | any[]} value The value to be judged, in pixel - * coordinate system. - */ - containPixel(finder: EChartsConvertFinder, value: any[]): boolean; - - /** - * Shows loading animation. You can call this interface manually before - * data is loaded, and call `hideLoading` to hide loading animation - * after data is loaded. - * - * @param {string} [type='default'] - * @param {EChartsLoadingOption} [opts] - */ - showLoading(type?: string, opts?: EChartsLoadingOption): void; - - /** - * Hides animation loading effect. - */ - hideLoading(): void; - - /** - * Exports chart image; returns a base64 URL; can be set to `src` of - * `Image`. - * - * @param opts Options. - */ - getDataURL(opts: { - // Exporting format, can be either png, or jpeg - type?: string | undefined; - // Resolution ratio of exporting image, 1 by default. - pixelRatio?: number | undefined; - // Background color of exporting image, use backgroundColor in - // option by default. - backgroundColor?: string | undefined; - // Excluded components list. e.g. ['toolbox'] - excludeComponents?: string[] | undefined; - }): string; - - /** - * Exports connected chart image; returns a base64 url; can be set to - * `src` of `Image`. Position of charts in exported image are - * related to that of the container. - * - * @param opts Options. - */ - getConnectedDataURL(opts: { - // Exporting format, can be either png, or jpeg - type: string; - // Resolution ratio of exporting image, 1 by default. - pixelRatio: number; - // Background color of exporting image, use backgroundColor in - // option by default. - backgroundColor: string; - // Excluded components list. e.g. ['toolbox'] - excludeComponents?: string[] | undefined; - }): string; - - /** - * The method is used in rendering millions of data - * (e.g. rendering geo data). In these scenario, the entire size of - * data is probably up to 10 or 100 MB, even using binary format. - * So chunked load data and rendering is required. When using - * `appendData`, the graphic elements that have been rendered will - * not be cleared, but keep rendering new graphic elements. - * - * @param opts Data options. - */ - appendData(opts: { - // Specify which series the data will be appended to. - seriesIndex?: string | undefined; - // The data to be appended. - data?: any[] | TypedArray | undefined; - }): void; - - /** - * Clears current instance; removes all components and charts in - * current instance. - */ - clear(): void; - - /** - * Returns whether current instance has been disposed. - * - * @return {boolean} Whether has been disposed. - */ - isDisposed(): boolean; - - /** - * Disposes instance. Once disposed, the instance can not be used again. - */ - dispose(): void; - } - - type TypedArray = - | Int8Array - | Uint8Array - | Int16Array - | Uint16Array - | Int32Array - | Uint32Array - | Uint8ClampedArray - | Float32Array - | Float64Array; - - interface EChartsConvertFinder { - seriesIndex?: number | undefined; - seriesId?: string | undefined; - seriesName?: string | undefined; - geoIndex?: number | undefined; - geoId?: string | undefined; - geoName?: string | undefined; - xAxisIndex?: number | undefined; - xAxisId?: string | undefined; - xAxisName?: string | undefined; - yAxisIndex?: number | undefined; - yAxisId?: string | undefined; - yAxisName?: string | undefined; - gridIndex?: number | undefined; - gridId?: string | undefined; - gridName?: string | undefined; - } - - interface ERectangle { - x: number; - y: number; - width: number; - height: number; - } - - 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://echarts.apache.org/en/option.html#title - */ - title?: EChartTitleOption | EChartTitleOption[] | undefined; - - /** - * 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://echarts.apache.org/en/option.html#legend - */ - legend?: EChartOption.Legend | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid - */ - grid?: EChartOption.Grid | EChartOption.Grid[] | undefined; - - /** - * 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://echarts.apache.org/en/option.html#xAxis - */ - xAxis?: EChartOption.XAxis | EChartOption.XAxis[] | undefined; - - /** - * 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://echarts.apache.org/en/option.html#yAxis - */ - yAxis?: EChartOption.YAxis | EChartOption.YAxis[] | undefined; - - /** - * Polar coordinate can be used in scatter and line chart. - * Every polar coordinate has an `angleAxis` and a `radiusAxis`. - * - * @see https://echarts.apache.org/en/option.html#polar - */ - polar?: object | undefined; - - /** - * Radial axis of polar coordinate. - * - * @see https://echarts.apache.org/en/option.html#radiusAxis - */ - radiusAxis?: object | undefined; - - /** - * The angle axis in Polar Coordinate. - * - * @see https://echarts.apache.org/en/option.html#angleAxis - */ - angleAxis?: object | undefined; - - /** - * 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://echarts.apache.org/en/option.html#radar - */ - radar?: object | undefined; - - /** - * `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://echarts.apache.org/en/option.html#dataZoom - */ - dataZoom?: EChartOption.DataZoom[] | undefined; - - /** - * `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://echarts.apache.org/en/option.html#visualMap - */ - visualMap?: EChartOption.VisualMap[] | undefined; - - /** - * 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://echarts.apache.org/en/option.html#tooltip - */ - tooltip?: EChartOption.Tooltip | undefined; - - /** - * `axisPointer` is a tool for displaying reference line and axis value - * under mouse pointer. - * - * @see https://echarts.apache.org/en/option.html#axisPointer - */ - axisPointer?: EChartOption.AxisPointer | undefined; - - /** - * A group of utility tools, which includes `export`, `data view`, - * `dynamic type switching`, `data area zooming`, and `reset`. - * - * @see https://echarts.apache.org/en/option.html#toolbox - */ - toolbox?: object | undefined; - - /** - * `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://echarts.apache.org/en/option.html#brush - */ - brush?: object | undefined; - - /** - * Geographic coorinate system component. - * Geographic coorinate system component is used to draw maps, - * which also supports `scatter series`, and `line series`. - * - * @see https://echarts.apache.org/en/option.html#geo - */ - geo?: object | undefined; - - /** - * `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://echarts.apache.org/en/option.html#parallel - */ - parallel?: object | undefined; - - /** - * This component is the coordinate axis for parallel coordinate. - * - * @see https://echarts.apache.org/en/option.html#parallelAxis - */ - parallelAxis?: object | undefined; - - /** - * An axis with a single dimension. It can be used to display data - * in one dimension. - * - * @see https://echarts.apache.org/en/option.html#singleAxis - */ - singleAxis?: EChartOption.SingleAxis | EChartOption.SingleAxis[] | undefined; - - /** - * `timeline` component, which provides functions like switching and playing - * between multiple ECharts `options`. - * - * @see https://echarts.apache.org/en/option.html#timeline - */ - timeline?: object | undefined; - - /** - * `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://echarts.apache.org/en/option.html#graphic - */ - graphic?: object | object[] | undefined; - - /** - * 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://echarts.apache.org/en/option.html#calendar - */ - calendar?: EChartOption.Calendar | EChartOption.Calendar[] | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#dataset - */ - dataset?: EChartOption.Dataset | EChartOption.Dataset[] | undefined; - - /** - * `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://echarts.apache.org/en/option.html#aria - */ - aria?: object | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series - */ - series?: TSeries[] | undefined; - - /** - * 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://echarts.apache.org/en/option.html#color - */ - color?: string[] | undefined; - - /** - * Background color. Defaults to have no background. - * - * @see https://echarts.apache.org/en/option.html#backgroundColor - */ - backgroundColor?: EChartOption.Color | undefined; - - /** - * Global font style. - * - * @see https://echarts.apache.org/en/option.html#textStyle - */ - textStyle?: (EChartOption.BaseTextStyle & EChartOption.BaseTextStyleWithRich) | undefined; - - /** - * Whether to enable animation. - * - * @see https://echarts.apache.org/en/option.html#animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger than threshold. - * - * @see https://echarts.apache.org/en/option.html#animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#animationDuration - */ - animationDuration?: number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at `easing effect example`. - * - * @see https://echarts.apache.org/en/option.html#animationEasing - */ - animationEasing?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#animationDelay - */ - animationDelay?: number | Function | undefined; - - /** - * 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://echarts.apache.org/en/option.html#animationDurationUpdate - */ - animationDurationUpdate?: number | Function | undefined; - - /** - * Easing method used for animation. - * - * @see https://echarts.apache.org/en/option.html#animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#animationDelayUpdate - */ - animationDelayUpdate?: number | Function | undefined; - - /** - * Configuration for progressive/incremental rendering - * - * @default 400 - */ - progressive?: number | undefined; - - /** - * Configuration for progressive/incremental rendering - * - * @default 3000 - */ - progressiveThreshold?: number | undefined; - - /** - * Equal to CanvasRenderingContext2D.globalCompositeOperation - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation - */ - blendMode?: string | undefined; - - /** - * 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 | undefined; - - /** - * 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://echarts.apache.org/en/option.html#useUTC - */ - useUTC?: boolean | undefined; - } - - type EChartsMediaOption = { - query: { - width?: number | undefined; - height?: number | undefined; - aspectRatio?: number | undefined; - minWidth?: number | undefined; - minHeight?: number | undefined; - minAspectRatio?: number | undefined; - maxWidth?: number | undefined; - maxHeight?: number | undefined; - maxAspectRatio?: number | undefined; - }; - option: EChartOption; - }; - - interface EChartsResponsiveOption { - baseOption?: EChartOption | undefined; - media?: EChartsMediaOption[] | undefined; - } - - interface EChartsOptionConfig { - notMerge?: boolean | undefined; - lazyUpdate?: boolean | undefined; - silent?: boolean | undefined; - } - - interface EChartsResizeOption { - /** - * Chart width. - */ - width?: number | string | undefined; - - /** - * Chart height. - */ - height?: number | string | undefined; - - /** - * Specify whether or not to prevent triggering events. - */ - silent?: boolean | undefined; - } - - interface EChartTitleOption { - show?: boolean | undefined; - text?: string | undefined; - link?: string | undefined; - target?: string | undefined; - textStyle?: EChartOption.TextStyleWithRich | undefined; - subtext?: string | undefined; - sublink?: string | undefined; - subtarget?: string | undefined; - subtextStyle?: EChartOption.TextStyleWithRich | undefined; - textAlign?: string | undefined; - textVerticalAlign?: string | undefined; - triggerEvent?: boolean | undefined; - /** - * Title 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. - */ - padding?: number | number[] | undefined; - itemGap?: number | undefined; - zlevel?: number | undefined; - z?: number | undefined; - left?: string | number | undefined; - top?: string | number | undefined; - right?: string | number | undefined; - bottom?: string | number | undefined; - backgroundColor?: string | undefined; - borderColor?: string | undefined; - borderWidth?: number | undefined; - borderRadius?: number | number[] | undefined; - shadowBlur?: number | undefined; - shadowColor?: number | undefined; - shadowOffsetX?: number | undefined; - shadowOffsetY?: number | undefined; - } - - /** - * Options for `echartsInstance.showLoading` method - * {@link https://echarts.apache.org/en/api.html#echartsInstance.showLoading} - */ - interface EChartsLoadingOption { - /** - * Loading text. - * @default 'loading' - */ - text?: string | undefined; - - /** - * Loading circle color. - * @default '#c23531' - */ - color?: string | undefined; - - /** - * Loading text color. - * @default '#000' - */ - textColor?: string | undefined; - - /** - * Mask background color. - * @default 'rgba(255, 255, 255, 0.8)' - */ - maskColor?: string | undefined; - - /** - * Zlevel of loading. If not 0, it creates a new canvas for loading. - * @default 0 - */ - zlevel?: number | undefined; - - /** - * Font size. - * @default 12 - * @since 4.8.0 - */ - fontSize?: number | undefined; - - /** - * Show an animated "spinner" or not. - * @default true - * @since 4.8.0 - */ - showSpinner?: boolean | undefined; - - /** - * Radius of the "spinner". - * @default 10 - * @since 4.8.0 - */ - spinnerRadius?: number | undefined; - - /** - * Line width of the "spinner". - * @default 5 - * @since 4.8.0 - */ - lineWidth?: number | undefined; - } - - namespace EChartOption { - type Series = - | SeriesLine - | SeriesBar - | SeriesPie - | SeriesScatter - | SeriesEffectScatter - | SeriesRadar - | SeriesTree - | SeriesTreemap - | SeriesSunburst - | SeriesBoxplot - | SeriesCandlestick - | SeriesHeatmap - | SeriesMap - | SeriesParallel - | SeriesLines - | SeriesGraph - | SeriesSankey - | SeriesFunnel - | SeriesGauge - | SeriesPictorialBar - | SeriesThemeRiver - | SeriesCustom; - - namespace BasicComponents { - /** - * @todo describe - */ - interface Line { - show?: boolean | undefined; - onZero?: boolean | undefined; - onZeroAxisIndex?: number | undefined; - symbol?: string | string[] | undefined; - symbolSize?: number[] | undefined; - symbolOffset?: number[] | undefined; - lineStyle?: LineStyle | undefined; - } - - interface CartesianAxis { - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option or API. - */ - id?: string | undefined; - - /** - * If show this axis. - * - * @default 'true' - */ - show?: boolean | undefined; - - /** - * The index of grid which this axis belongs to. - * Defaults to be in the first grid. - * - * @default 0 - */ - gridIndex?: number | undefined; - - /** - * Offset of this axis relative to default position. - * Useful when multiple axis of this type has same position value. - * - * @default 0 - * @see https://echarts.apache.org/en/option.html#yAxis.offset - */ - offset?: number | undefined; - - /** - * Name of axis. - */ - name?: string | undefined; - - /** - * Location of axis name. - * - * @default 'start' - */ - nameLocation?: "start" | "middle" | "center" | "end" | undefined; - - /** - * Text style of axis name. - * - * @see https://echarts.apache.org/en/option.html#yAxis.nameTextStyle - */ - nameTextStyle?: TextStyleWithRich | undefined; - - /** - * Gap between axis name and axis line. - * - * @default 15 - */ - nameGap?: number | undefined; - - /** - * Rotation of axis name. - * - * @default null - */ - nameRotate?: number | undefined; - - /** - * Whether axis is inversed. New option from ECharts 3. - * - * @default false - */ - inverse?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#yAxis.boundaryGap - */ - boundaryGap?: boolean | Array | undefined; - - /** - * 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://echarts.apache.org/option.html#yAxis.min - */ - min?: number | string | ((value: { min: number; max: number }) => number) | undefined; - - /** - * 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://echarts.apache.org/option.html#yAxis.max - */ - max?: number | string | ((value: { min: number; max: number }) => number) | undefined; - - /** - * 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://echarts.apache.org/en/option.html#yAxis.scale - */ - scale?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#yAxis.splitNumber - */ - splitNumber?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#yAxis.interval - */ - interval?: number | undefined; - - /** - * Base of logarithm, which is valid only for numeric axes with type: - * `'log'`. - * - * @default 10 - * @see https://echarts.apache.org/en/option.html#yAxis.logBase - */ - logBase?: number | undefined; - - /** - * True for axis that cannot be interacted with. - * - * @default false - */ - silent?: boolean | undefined; - - /** - * 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 | undefined; - - /** - * Settings related to axis line. - * - * @see https://echarts.apache.org/en/option.html#yAxis.axisLine - */ - axisLine?: Line | undefined; - - /** - * Settings related to axis tick. - * - * @see https://echarts.apache.org/en/option.html#yAxis.axisTick - */ - axisTick?: CartesianAxis.Tick | undefined; - - /** - * Settings related to axis minor tick. - * - * @see https://echarts.apache.org/en/option.html#yAxis.minorTick - */ - minorTick?: CartesianAxis.MinorTick | undefined; - - /** - * Settings related to axis label. - * - * @see https://echarts.apache.org/en/option.html#yAxis.axisLabel - */ - - axisLabel?: CartesianAxis.Label | undefined; - - /** - * SplitLine of axis in grid area. - * - * @see https://echarts.apache.org/en/option.html#yAxis.splitLine - */ - splitLine?: CartesianAxis.SplitLine | undefined; - - /** - * Minor SplitLine of axis in grid area. - * - * @see https://echarts.apache.org/en/option.html#yAxis.minorSplitLine - */ - minorSplitLine?: CartesianAxis.MinorSplitLine | undefined; - - /** - * Split area of axis in grid area, not shown by default. - * - * @see https://echarts.apache.org/en/option.html#yAxis.splitArea - */ - splitArea?: CartesianAxis.SplitArea | undefined; - - /** - * 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://echarts.apache.org/en/option.html#yAxis.data - */ - data?: Array | undefined; - - /** - * axisPointer settings on the axis. - * - * @see https://echarts.apache.org/en/option.html#yAxis.axisPointer - */ - axisPointer?: CartesianAxis.Pointer | undefined; - - /** - * `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://echarts.apache.org/en/option.html#yAxis.zlevel - */ - zlevel?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#yAxis.z - */ - z?: number | undefined; - } - - namespace CartesianAxis { - type Type = "value" | "category" | "time" | "log"; - - /** - * @todo describe - */ - interface Tick { - show?: boolean | undefined; - alignWithLabel?: boolean | undefined; - interval?: number | Function | undefined; - inside?: boolean | undefined; - length?: number | undefined; - lineStyle?: LineStyle | undefined; - } - - /** - * @todo describe - */ - interface MinorTick { - show?: boolean | undefined; - splitNumber?: number | undefined; - length?: number | undefined; - lineStyle?: LineStyle | undefined; - } - - /** - * @todo describe - */ - interface Label extends Omit { - color?: string | ((val: string) => EChartOption.Color) | undefined; - show?: boolean | undefined; - interval?: number | Function | undefined; - inside?: boolean | undefined; - rotate?: number | undefined; - margin?: number | undefined; - formatter?: string | Function | undefined; - showMinLabel?: boolean | undefined; - showMaxLabel?: boolean | undefined; - } - - /** - * @todo describe - */ - interface SplitLine { - show?: boolean | undefined; - interval?: number | Function | undefined; - lineStyle?: LineStyle | undefined; - } - - /** - * @todo describe - */ - interface MinorSplitLine { - show?: boolean | undefined; - lineStyle?: LineStyle | undefined; - } - - /** - * @todo describe - */ - interface SplitArea { - interval?: number | Function | undefined; - show?: boolean | undefined; - areaStyle?: { - color?: string[] | undefined; - shadowBlur?: number | undefined; - shadowColor?: string | undefined; - shadowOffsetX?: number | undefined; - shadowOffsetY?: number | undefined; - opacity?: number | undefined; - } | undefined; - } - - /** - * @todo describe - */ - interface DataObject { - value?: string | number | undefined; - textStyle?: TextStyleWithRich | undefined; - } - - /** - * @todo describe - */ - interface Pointer { - show?: boolean | undefined; - type?: "line" | "shadow" | "none" | undefined; - snap?: boolean | undefined; - z?: number | undefined; - label?: PointerLabel | undefined; - lineStyle?: LineStyle | undefined; - shadowStyle?: { - color?: EChartOption.Color | undefined; - shadowBlur?: number | undefined; - shadowColor?: EChartOption.Color | undefined; - shadowOffsetX?: number | undefined; - shadowOffsetY?: number | undefined; - opacity?: number | undefined; - } | undefined; - triggerTooltip?: boolean | undefined; - value?: number | undefined; - status?: boolean | undefined; - handle?: { - show?: boolean | undefined; - icon?: any; - size?: number | number[] | undefined; - margin?: number | undefined; - color?: string | undefined; - throttle?: number | undefined; - shadowBlur?: number | undefined; - shadowColor?: string | undefined; - shadowOffsetX?: number | undefined; - shadowOffsetY?: number | undefined; - } | undefined; - } - - interface PointerLabel { - show?: boolean | undefined; - precision?: number | string | undefined; - formatter?: string | Function | undefined; - margin?: number | undefined; - color?: string | undefined; - fontStyle?: "normal" | "italic" | "oblique" | undefined; - fontWeight?: - | "normal" - | "bold" - | "bolder" - | "lighter" - | 100 - | 200 - | 300 - | 400 - | 500 - | 600 - | 700 - | 800 - | 900 - | undefined; - fontFamily?: string | undefined; - fontSize?: number | undefined; - lineHeight?: number | undefined; - backgroundColor?: string | object | undefined; - borderColor?: string | undefined; - borderWidth?: number | undefined; - borderRadius?: number | undefined; - padding?: number | number[] | undefined; - shadowColor?: string | undefined; - shadowBlur?: number | undefined; - shadowOffsetX?: number | undefined; - shadowOffsetY?: number | undefined; - width?: number | string | undefined; - height?: number | string | undefined; - textBorderColor?: string | undefined; - textBorderWidth?: number | undefined; - textShadowColor?: string | undefined; - textShadowBlur?: number | undefined; - textShadowOffsetX?: number | undefined; - textShadowOffsetY?: number | undefined; - } - } - } - } -} - -declare module "echarts" { - export = echarts; -} - -declare module "echarts/lib/echarts" { - export = echarts; -} diff --git a/types/echarts/options/axis-pointer.d.ts b/types/echarts/options/axis-pointer.d.ts deleted file mode 100644 index 3ff3c4217da3b09..000000000000000 --- a/types/echarts/options/axis-pointer.d.ts +++ /dev/null @@ -1,64 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * @todo describe - */ - interface AxisPointer extends BasicComponents.CartesianAxis.Pointer { - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component - * in option or API. - */ - id?: string | undefined; - - /** - * 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://echarts.apache.org/examples/en/view.html?c=candlestick-brush&edit=1&reset=1) - * and - * [sampleB](https://echarts.apache.org/examples/en/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://echarts.apache.org/en/option.html#axisPointer.link - */ - link?: object[] | undefined; - - /** - * 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" | undefined; - } - } -} diff --git a/types/echarts/options/calendar.d.ts b/types/echarts/options/calendar.d.ts deleted file mode 100644 index 8920b6d9169db6a..000000000000000 --- a/types/echarts/options/calendar.d.ts +++ /dev/null @@ -1,237 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * Calendar coordinates. - * - * @see https://echarts.apache.org/en/option.html#calendar - */ - interface Calendar { - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option or API. - */ - id?: string | undefined; - /** - * zlevel value of all graphical 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. - * - * @default 0 - */ - zlevel?: number | undefined; - /** - * z value of all graphical 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 - */ - z?: number | undefined; - /** - * Distance between calendar 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 80 - */ - left?: number | string | undefined; - /** - * Distance between calendar 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 60 - */ - top?: number | string | undefined; - /** - * Distance between calendar 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' - */ - right?: number | string | undefined; - /** - * Distance between calendar 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' - */ - bottom?: number | string | undefined; - /** - * The height of calendar coordinates. - * Note: cellSize is 20 by default. - * If width is set, cellSize[0] will be forced to auto; - * - * @default 'auto' - */ - width?: number | string | undefined; - /** - * The height of calendar coordinates. - * Note: cellSize is 20 by default. - * If height is set, cellSize[1] will be forced to auto; - */ - height?: number | string | undefined; - /** - * Required, range of Calendar coordinates, support multiple formats. - * - * @see https://echarts.apache.org/en/option.html#calendar - */ - range?: number | string | number[] | string[] | undefined; - /** - * The size of each rect of calendar coordinates, - * can be set to a single value or array, - * the first element is width and the second element is height. - * Support setting self-adaptation: auto, the default width and height to be 20. - * - * @default 20 - */ - cellSize?: number | "auto" | Array<"auto" | number> | undefined; - /** - * The layout orientation of calendar. - */ - orient?: "horizontal" | "vertical" | undefined; - /** - * Calendar coordinates splitLine style. - */ - splitLine?: { - /** - * Set this to false to prevent the splitLine from showing - * - * @default true - */ - show?: boolean | undefined; - lineStyle?: LineStyle | undefined; - } | undefined; - /** - * Every rect style in calendar coordinates. - * - * @see https://echarts.apache.org/en/option.html#calendar.itemStyle - */ - itemStyle?: { - color?: EChartOption.Color | undefined; - borderColor?: EChartOption.Color | undefined; - borderWidth?: number | undefined; - borderType?: "solid" | "dashed" | "dotted" | undefined; - shadowBlur?: number | undefined; - shadowColor?: EChartOption.Color | undefined; - shadowOffsetX?: number | undefined; - shadowOffsetY?: number | undefined; - opacity?: number | undefined; - } | undefined; - /** - * Day style in calendar coordinates. - * @see https://echarts.apache.org/en/option.html#calendar.dayLabel - */ - dayLabel?: Calendar.DayLabel | undefined; - /** - * Month label in calendar coordinates. - * @see https://echarts.apache.org/en/option.html#calendar.monthLabel - */ - monthLabel?: Calendar.MonthLabel | undefined; - /** - * Year label in calendar coordinates. - * @see https://echarts.apache.org/en/option.html#calendar.yearLabel - */ - yearLabel?: Calendar.YearLabel | undefined; - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to mouse events. - * - * @default false - */ - silent?: boolean | undefined; - } - namespace Calendar { - interface Label extends TextStyleWithRich { - /** - * Set this to false to prevent label from showing. - * - * @default true - */ - show?: boolean | undefined; - /** - * The margin between the label and the axis line. - */ - margin?: number | undefined; - /** - * Week text content, defaults to 'en'; It supports Chinese, English, and custom; - * index 0 always means Sunday; - * - * @default 'en' - */ - nameMap?: string | number | Array | undefined; - } - interface DayLabel extends Label { - /** - * A week from the beginning of the week, the default starting on Sunday. - * - * @default 0 - */ - firstDay?: number | undefined; - /** - * Position of week, at the beginning or end of the range. - * - * @default 'start' - */ - position?: "start" | "end" | undefined; - } - interface MonthLabel extends Label { - /** - * Formatter of month text label, which supports string template and callback function. - */ - formatter?: string | MonthLabelFormatter | undefined; - /** - * Position of week, at the beginning or end of the range. - * - * @default 'start' - */ - position?: "start" | "end" | undefined; - } - interface MonthLabelFormatter { - (params: MonthLabelFormatterParams): string; - } - interface MonthLabelFormatterParams { - nameMap?: string | number | Array | undefined; - yyyy?: number | undefined; - yy?: number | undefined; - MM?: number | undefined; - M?: number | undefined; - } - interface YearLabel extends Label { - /** - * Formatter of year text label, which supports string template and callback function. - * By default, the current range of the year, - * if the interval across the year, showing the first year and the last year - */ - formatter?: string | undefined; - /** - * Position of year. - * Default: when orient is set as horizontal, - * position is left when orient is set as vertical, position is top - */ - position?: "top" | "bottom" | "left" | "right" | undefined; - } - interface YearLabelFormatter { - (params: YearLabelFormatterParams): string; - } - interface YearLabelFormatterParams { - nameMap?: string | number | Array | undefined; - start?: number | undefined; - end?: number | undefined; - } - } - } -} diff --git a/types/echarts/options/color.d.ts b/types/echarts/options/color.d.ts deleted file mode 100644 index bbb327d16132093..000000000000000 --- a/types/echarts/options/color.d.ts +++ /dev/null @@ -1,62 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * Color type for itemStyle / areaStyle etc. - * + string - * + LinearGradient - * + RadialGradient. - * + Texture - */ - type Color = string | LinearGradient | RadialGradient | Texture; - - /** - * Linear gradient. - * - * First four parameters are x0, y0, x2, and y2, each ranged from 0 to 1, standing for percentage in the bounding box. - * - * If global is `true`, then the first four parameters are in absolute pixel positions. - */ - interface LinearGradient { - type: "linear"; - x: number; - y: number; - x2: number; - y2: number; - colorStops: ColorStops; - global: boolean; - } - - /** - * Radial gradient. - * - * First three parameters are x and y positions of center, and radius, similar to linear gradient. - */ - interface RadialGradient { - type: "radial"; - x: number; - y: number; - r: number; - colorStops: ColorStops; - global: boolean; - } - - /** - * Fill with texture - */ - interface Texture { - /** - * HTMLImageElement, and HTMLCanvasElement are supported, while string path is not supported - */ - image: HTMLImageElement | HTMLCanvasElement; - /** - * whether to repeat texture, whose value can be repeat-x, repeat-y, or no-repeat - */ - repeat?: "repeat" | "repeat-x" | "repeat-y" | "no-repeat" | undefined; - } - - type ColorStops = Array<{ - offset: number; - color: string; - }>; - } -} diff --git a/types/echarts/options/data-zoom.d.ts b/types/echarts/options/data-zoom.d.ts deleted file mode 100644 index 9622b460db59219..000000000000000 --- a/types/echarts/options/data-zoom.d.ts +++ /dev/null @@ -1,110 +0,0 @@ -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://echarts.apache.org/en/option.html#dataZoom-inside - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#dataZoom-inside - */ - interface Inside { - type?: string | undefined; - id?: string | undefined; - disabled?: boolean | undefined; - xAxisIndex?: number | number[] | undefined; - yAxisIndex?: number | number[] | undefined; - radiusAxisIndex?: number | number[] | undefined; - angleAxisIndex?: number | number[] | undefined; - singleAxisIndex?: number | number[] | undefined; - filterMode?: "filter" | "weakFilter" | "empty" | "none" | undefined; - start?: number | undefined; - end?: number | undefined; - startValue?: number | string | Date | undefined; - endValue?: number | string | Date | undefined; - minSpan?: number | undefined; - maxSpan?: number | undefined; - minValueSpan?: number | string | Date | undefined; - maxValueSpan?: number | string | Date | undefined; - orient?: string | undefined; - zoomLock?: boolean | undefined; - throttle?: number | undefined; - rangeMode?: string[] | undefined; - zoomOnMouseWheel?: boolean | undefined; - moveOnMouseMove?: boolean | undefined; - moveOnMouseWheel?: boolean | undefined; - preventDefaultMouseMove?: boolean | undefined; - } - - /** - * @see https://echarts.apache.org/en/option.html#dataZoom-slider - */ - interface Slider { - type?: string | undefined; - id?: string | undefined; - show?: boolean | undefined; - backgroundColor?: string | undefined; - dataBackground?: object | undefined; - fillerColor?: string | undefined; - borderColor?: string | undefined; - handleIcon?: string | undefined; - handleSize?: number | string | undefined; - handleStyle?: object | undefined; - moveHandleIcon?: string | undefined; - moveHandleSize?: number | undefined; - moveHandleStyle?: object | undefined; - labelPrecision?: number | undefined; - labelFormatter?: string | Function | undefined; - showDetail?: boolean | undefined; - showDataShadow?: string | undefined; - realtime?: boolean | undefined; - textStyle?: BaseTextStyle | undefined; - xAxisIndex?: number | number[] | undefined; - yAxisIndex?: number | number[] | undefined; - radiusAxisIndex?: number | number[] | undefined; - angleAxisIndex?: number | number[] | undefined; - singleAxisIndex?: number | number[] | undefined; - filterMode?: "filter" | "weakFilter" | "empty" | "none" | undefined; - start?: number | undefined; - end?: number | undefined; - startValue?: number | string | Date | undefined; - endValue?: number | string | Date | undefined; - minSpan?: number | undefined; - maxSpan?: number | undefined; - minValueSpan?: number | string | Date | undefined; - maxValueSpan?: number | string | Date | undefined; - orient?: "vertical" | "horizontal" | undefined; - zoomLock?: boolean | undefined; - throttle?: number | undefined; - rangeMode?: string[] | undefined; - zlevel?: number | undefined; - z?: number | undefined; - left?: string | number | undefined; - top?: string | number | undefined; - right?: string | number | undefined; - bottom?: string | number | undefined; - } - } - } -} diff --git a/types/echarts/options/dataset.d.ts b/types/echarts/options/dataset.d.ts deleted file mode 100644 index cd1f6865c728ceb..000000000000000 --- a/types/echarts/options/dataset.d.ts +++ /dev/null @@ -1,45 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * 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. - * - * @see https://echarts.apache.org/en/option.html#dataset - */ - interface Dataset { - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option or API. - */ - id?: string | undefined; - /** - * Source data. Generally speaking, a source data describe a table, where these format below can be applied: - * 2d array, where dimension names can be provided in the first row/column, or do not provide, only data. - * - * @see https://echarts.apache.org/en/option.html#dataset.source - */ - source?: any[] | object | undefined; - /** - * dimensions can be used to define dimension info for series.data or dataset.source. - * Notice: if dataset is used, we can provide dimension names in the first column/row of 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. - * - * @see https://echarts.apache.org/en/option.html#dataset.dimensions - */ - dimensions?: string[] | Dataset.DimensionObject[] | undefined; - } - - namespace Dataset { - /** - * @see https://echarts.apache.org/en/option.html#dataset.dimensions - */ - interface DimensionObject { - name?: string | undefined; - type?: "number" | "float" | "int" | "ordinal" | "time" | undefined; - displayName?: string | undefined; - } - } - } -} diff --git a/types/echarts/options/grid.d.ts b/types/echarts/options/grid.d.ts deleted file mode 100644 index 99d7e51372f84bb..000000000000000 --- a/types/echarts/options/grid.d.ts +++ /dev/null @@ -1,159 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * 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. - * - * @see https://echarts.apache.org/en/option.html#grid - */ - interface Grid { - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option or API. - */ - id?: string | undefined; - /** - * Whether to show the grid in rectangular coordinate. - * - * @default false - */ - show?: boolean | undefined; - /** - * zlevel value of all graphical 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. - * - * @default 0 - */ - zlevel?: number | undefined; - /** - * z value of all graphical 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 - */ - z?: number | undefined; - /** - * Distance between grid 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 '10%' - */ - left?: number | string | undefined; - /** - * Distance between grid 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'. - * - * @default 60 - */ - top?: number | string | undefined; - /** - * Distance between grid component and the right side of the container. - * right value can be instant pixel value like 20; - * it can also be percentage value relative to container width like '20%'. - * - * @default '10%' - */ - right?: number | string | undefined; - /** - * Distance between grid component and the bottom side of the container. - * bottom value can be instant pixel value like 20; it can also be percentage value relative to container width like '20%'. - * - * @default 60 - */ - bottom?: number | string | undefined; - /** - * Width of grid component. Adaptive by default. - * - * @default 'auto' - */ - width?: number | string | undefined; - /** - * Height of grid component. Adaptive by default. - * - * @default 'auto' - */ - height?: number | string | undefined; - /** - * Whether the grid region contains axis tick label of axis. - * When containLabel is false: - * grid.left grid.right grid.top grid.bottom grid.width grid.height decide the location - * and size of the rectangle that is made of by xAxis and yAxis. - * Setting to false will help when multiple grids need to be aligned at their axes. - * When containLabel is true: - * grid.left grid.right grid.top grid.bottom grid.width grid.height decide the location - * and size of the rectangle that contains the axes and the labels of the axes. - * Setting to true will help when the length of axis labels is dynamic and is hard to approximate. - * This will avoid labels from overflowing the container or overlapping other components. - * - * @default false - */ - containLabel?: boolean | undefined; - /** - * Background color of grid, which is transparent by default. - * Attention: Works only if show: true is set. - * - * @default 'transparent' - */ - backgroundColor?: string | undefined; - /** - * Border color of grid. Support the same color format as backgroundColor. - * Attention: Works only if show: true is set. - * - * @default '#ccc' - */ - borderColor?: string | undefined; - /** - * Border width of grid. - * Attention: Works only if show: true is set. - * - * @default 1 - */ - borderWidth?: number | undefined; - /** - * Size of shadow blur. This attribute should be used along with - * shadowColor,shadowOffsetX, shadowOffsetY to set shadow to component. - * Attention: - * This property works only if show: true is configured and - * backgroundColor is defined other than transparent. - */ - shadowBlur?: number | undefined; - /** - * Shadow color. Support same format as color. - * Attention: This property works only if show: true configured. - */ - shadowColor?: string | undefined; - /** - * Offset distance on the horizontal direction of shadow. - * Attention: This property works only if show: true configured. - * - * @default 0 - */ - shadowOffsetX?: number | undefined; - /** - * Offset distance on the vertical direction of shadow. - * Attention: This property works only if show: true configured. - * - * @default 0 - */ - shadowOffsetY?: number | undefined; - /** - * tooltip settings in the coordinate system component. - * @see https://echarts.apache.org/en/option.html#grid.tooltip - */ - tooltip?: Tooltip | undefined; - } - } -} diff --git a/types/echarts/options/index.d.ts b/types/echarts/options/index.d.ts deleted file mode 100644 index 91b2bd76b777af8..000000000000000 --- a/types/echarts/options/index.d.ts +++ /dev/null @@ -1,36 +0,0 @@ -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// diff --git a/types/echarts/options/legend.d.ts b/types/echarts/options/legend.d.ts deleted file mode 100644 index 4ecb188b2e7c84e..000000000000000 --- a/types/echarts/options/legend.d.ts +++ /dev/null @@ -1,647 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * @see https://echarts.apache.org/en/option.html#legend - */ - interface Legend { - /** - * Type of legend. - * Optional values: - * 'plain': Simple legend. (default) - * 'scroll': Scrollable legend. It helps when too - * many legend items needed to be shown. - * - * @default 'plain' - */ - type?: "plain" | "scroll" | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option or API. - */ - id?: string | undefined; - /** - * Whether to show the legend component. - * @default true - */ - show?: boolean | undefined; - /** - * zlevel value of all graphical 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. - * - * @default 0 - */ - zlevel?: number | undefined; - /** - * z value of all graphical 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 - */ - z?: number | undefined; - /** - * Distance between legend 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 'auto' - */ - left?: string | number | undefined; - /** - * Distance between legend 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 'auto' - */ - top?: string | number | undefined; - /** - * Distance between legend 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' - */ - right?: string | number | undefined; - /** - * Distance between legend 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' - */ - bottom?: string | number | undefined; - /** - * Width of legend component. Adaptive by default. - * - * @default 'auto' - */ - width?: string | number | undefined; - /** - * Height of legend component. Adaptive by default. - * - * @default 'auto' - */ - height?: string | number | undefined; - /** - * The layout orientation of legend. - * - * @default 'horizontal' - */ - orient?: "horizontal" | "vertical" | undefined; - /** - * Legend mrker and text aligning. By default, - * it automatically calculates from component location and orient. - * When left value of this component is 'right', - * and the vertical layout (orient is 'vertical'), - * it would be aligned to 'right'. - * - * @default 'auto' - */ - align?: "auto" | "left" | "right" | undefined; - /** - * Legend 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. - * - * @example - * ``` - * // Set padding to be 5 - * padding: 5 - * // Set the top and bottom paddings to be 5, and left and right paddings to be 10 - * padding: [5, 10] - * // Set each of the four paddings seperately - * padding: [ - * 5, // up - * 10, // right - * 5, // down - * 10, // left - * ] - * ``` - */ - padding?: number | number[] | undefined; - /** - * The distance between each legend, horizontal distance in horizontal layout, - * and vertical distance in vertical layout. - * - * @default 10 - */ - itemGap?: number | undefined; - /** - * Image width of legend symbol. - * - * @default 25 - */ - itemWidth?: number | undefined; - /** - * Image height of legend symbol. - * - * @default 14 - */ - itemHeight?: number | undefined; - /** - * Whether to keep aspect for icons - * (from series.symbol or user-defined legend.data.icon) in the form of path://. - * - * @default true - */ - symbolKeepAspect?: boolean | undefined; - /** - * Formatter is used to format label of legend, which supports string template and callback function. - * - * @default null - */ - formatter?: string | Legend.Formatter | undefined; - /** - * Selected mode of legend, which controls whether series can be toggled displaying by clicking legends. - * It is enabled by default, and you may set it to be false to disabled it. - * Besides, it can be set to 'single' or 'multiple', for single selection and multiple selection. - * - * @default true - */ - selectedMode?: boolean | "single" | "multiple" | undefined; - /** - * Legend color when not selected. - * - * @default '#ccc' - */ - inactiveColor?: string | undefined; - /** - * State table of selected legend. - * - * @example - * ``` - * selected: { - * // selected'series 1' - * 'series 1': true, - * // unselected'series 2' - * 'series 2': false - * } - * ``` - */ - selected?: object | undefined; - /** - * Legend text style. - */ - textStyle?: TextStyleWithRich | undefined; - /** - * Tooltip configuration for legend tooltip, which is similar to tooltip. - * - * @see https://echarts.apache.org/en/option.html#legend.tooltip - */ - tooltip?: Tooltip | undefined; - /** - * Icon of the legend items. - * 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. - * 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 for more information about format of path. You may export vector paths from tools like Adobe Illustrator. - * - * @see https://echarts.apache.org/en/option.html#legend.icon - */ - icon?: string | undefined; - /** - * Data array of legend. An array item is usually a name representing string. - * (If it is a pie chart, it could also be the name of a single data in the pie chart) of a series. - * Legend component would automatically calculate the color and icon according to series. - * Special string '' (null string) or '\n' (new line string) can be used for a new line. - * If data is not specified, it will be auto collected from series. For most of series, - * it will be collected from series.name or the dimension name specified by seriesName of series.encode. - * For some types of series like pie and funnel, it will be collected from the name field of series.data. - * If you need to set the style for a single item, you may also set the configuration of it. - * In this case, name attribute is used to represent name of series. - * - * @see https://echarts.apache.org/en/option.html#legend.data - */ - data?: string[] | Legend.LegendDataObject[] | undefined; - /** - * Background color of legend, which is transparent 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'. - * - * @default 'transparent' - */ - backgroundColor?: string | undefined; - /** - * Border color of legend. Support the same color format as backgroundColor. - * - * @default '#ccc' - */ - borderColor?: string | undefined; - /** - * Border width of legend. - * - * @default 1 - */ - borderWidth?: number | undefined; - /** - * The radius of rounded corner. Its unit is px. - * And it supports use array to respectively specify the 4 corner radiuses. - * - * @default 0 - * - * @example - * - * ``` - * borderRadius: 5, // consistently set the size of 4 rounded corners - * borderRadius: [5, 5, 0, 0] // (clockwise upper left, upper right, bottom right and bottom left) - * ``` - */ - borderRadius?: number | number[] | undefined; - /** - * Size of shadow blur. This attribute should be used along with shadowColor, - * shadowOffsetX, shadowOffsetY to set shadow to component. - * Attention: - * This property works only if show: true is configured and backgroundColor is defined other than transparent. - */ - shadowBlur?: number | undefined; - /** - * Shadow color. Support same format as color. - * Attention: This property works only if show: true configured. - */ - shadowColor?: string | undefined; - /** - * Offset distance on the horizontal direction of shadow. - * Attention: This property works only if show: true configured. - * - * @default 0 - */ - shadowOffsetX?: number | undefined; - /** - * Offset distance on the vertical direction of shadow. - * Attention: This property works only if show: true configured. - * - * @default 0 - */ - shadowOffsetY?: number | undefined; - /** - * It works when legend.type is 'scroll'. - * dataIndex of the left top most displayed item. - * Although the scrolling of legend items can be controlled by calling setOption and specifying this property, - * we suggest that do not controll legend in this way unless necessary (setOption might be time-consuming), - * but just use action legendScroll to do that. - * - * @default 0 - * @see https://echarts.apache.org/en/option.html#legend.scrollDataIndex - */ - scrollDataIndex?: number | undefined; - /** - * It works when legend.type is 'scroll'. - * The gap between page buttons and page info text. - * - * @default 5 - */ - pageButtonItemGap?: number | undefined; - /** - * It works when legend.type is 'scroll'. - * The gap between page buttons and legend items. - * - * @default null - */ - pageButtonGap?: number | undefined; - /** - * It works when legend.type is 'scroll'. - * The position of page buttons and page info. Optional values: - * 'start': on the left or top. - * 'end': on the right or bottom. - * - * @default 'end' - */ - pageButtonPosition?: "start" | "end" | undefined; - /** - * It works when legend.type is 'scroll'. - * Page info formatter. It is '{current}/{total}' by default, - * where {current} is current page number (start from 1), and {total} is the total page number. - * - * @default '{current}/{total}' - */ - pageFormatter?: string | Legend.PageFormatter | undefined; - /** - * @see https://echarts.apache.org/en/option.html#legend.pageIcons - */ - pageIcons?: Legend.PageIcons | undefined; - /** - * It works when legend.type is 'scroll'. - * The color of page buttons. - * - * @default '#2f4554' - */ - pageIconColor?: string | undefined; - /** - * It works when legend.type is 'scroll'. - * The color of page buttons when they are inactive. - * - * @default '#aaa' - */ - pageIconInactiveColor?: string | undefined; - /** - * It works when legend.type is 'scroll'. - * The size of page buttons. It can be a number, or an array, like [10, 3], represents [width, height]. - * - * @default 15 - */ - pageIconSize?: number | number[] | undefined; - /** - * It works when legend.type is 'scroll'. - * The text style of page info. - */ - pageTextStyle?: TextStyle | undefined; - /** - * Whether to use animation when page scrolll. - */ - animation?: boolean | undefined; - /** - * Duration of the page scroll animation. - * - * @default 800 - */ - animationDurationUpdate?: number | undefined; - /** - * The selector button in the legend component. - * Currently includes both a full selection and an inverse selection. - * The selector button doesn't display by default, the user can manually configure it. - */ - selector?: boolean | string[] | Array<{ type: string; title: string }> | undefined; - /** - * The text label style of the selector button, which is displayed by default. - */ - selectorLabel?: Legend.SelectorLabel | undefined; - /** - * The position of the selector button, which can be placed at the end or start of the legend component, - * the corresponding values are 'end' and 'start'. - * By default, when the legend is laid out horizontally, the selector is placed at the end of it, - * and when the legend is laid out vertically, the selector is placed at the start of it. - * - * @default 'auto' - */ - selectorPosition?: string | undefined; - /** - * The gap between the selector button. - * - * @default 7 - */ - selectorItemGap?: number | undefined; - /** - * The gap between selector button and legend component. - * - * @default 10 - */ - selectorButtonGap?: number | undefined; - } - - namespace Legend { - interface Formatter { - (name: string): string; - } - interface LegendDataObject { - /** - * Name of legend, which should be the name value of a certain series. - * If it is a pie chart, legend name can also be the name of a single data item. - */ - name?: string | undefined; - /** - * Icon of the legend items. - * 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. - * 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 for more information about format of path. You may export vector paths from tools like Adobe Illustrator. - * - * @see https://echarts.apache.org/en/option.html#legend.data.icon - */ - icon?: string | undefined; - /** - * Text style of legend. - */ - textStyle?: TextStyle | undefined; - } - interface PageFormatter { - (current: number, total: number): string; - } - interface PageIcons { - /** - * The icons of page buttons when legend.orient is 'horizontal'. - * It should be an array, [previous page button, next page button], ['M0,0L12,-10L12,10z', 'M0,0L-12,-10L-12,10z'] by default. - * - * @see https://echarts.apache.org/en/option.html#legend.pageIcons.horizontal - */ - horizontal?: string[] | undefined; - /** - * The icons of page buttons when legend.orient is 'vertical'. - * It should be an array, [previous page button, next page button], ['M0,0L20,0L10,-20z', 'M0,0L20,0L10,20z'] by default. - * - * @see https://echarts.apache.org/en/option.html#legend.pageIcons.vertical - */ - vertical?: string[] | undefined; - } - interface SelectorLabel { - /** - * Whether to show label. - * - * @default false - */ - show?: boolean | undefined; - /** - * Distance to the host graphic element. Works when position is string value (like 'top'、'insideRight'). - * - * @default 5 - * - * @see https://echarts.apache.org/examples/zh/editor.html?c=doc-example/label-position - */ - distance?: number | undefined; - /** - * Rotate label, from -90 degree to 90, positive value represents rotate anti-clockwise. - * - * @see https://echarts.apache.org/examples/zh/editor.html?c=bar-label-rotation - */ - rotate?: number | undefined; - /** - * text color. - * If set as 'auto', the color will assigned as visual color, such as series color. - * - * @default '#fff' - */ - color?: Color | undefined; - /** - * font style. - * Options are:'normal','italic','oblique' - * - * @default 'normal' - */ - fontStyle?: "normal" | "italic" | "oblique" | undefined; - /** - * font thick weight. - * - * @default 'normal' - */ - fontWeight?: - | "normal" - | "bold" - | "bolder" - | "lighter" - | 100 - | 200 - | 300 - | 400 - | 500 - | 600 - | 700 - | 800 - | 900 - | undefined; - /** - * font family. - * - * @default 'sans-serif' - */ - fontFamily?: string | undefined; - /** - * font size - * - * @default 12 - */ - fontSize?: number | undefined; - /** - * Horizontal alignment of text, automatic by default. - */ - align?: "left" | "center" | "right" | undefined; - /** - * Vertical alignment of text, automatic by default. - */ - verticalAlign?: "top" | "middle" | "bottom" | undefined; - /** - * Line height of the text fragment. - */ - lineHeight?: number | undefined; - /** - * Background color of the text fragment. - * Can be color string, like '#123234', 'red', 'rgba(0,23,11,0.3)'. - * Or image can be used, for example: - * @example - * ```ts - * backgroundColor: { - * image: 'xxx/xxx.png' - * // It can be URL of a image, - * // or dataURI, - * // or HTMLImageElement, - * // or HTMLCanvasElement. - * } - * ``` - * - * width or height can be specified when using background image, or auto adapted by default. - * If set as 'auto', the color will assigned as visual color, such as series color. - * - * @default 'transparent' - */ - backgroundColor?: string | object | undefined; - /** - * Border color of the text fragment. - * If set as 'auto', the color will assigned as visual color, such as series color. - * @default 'transparent' - */ - borderColor?: Color | undefined; - /** - * Border width of the text fragment. - */ - borderWidth?: number | undefined; - /** - * Border radius of the text fragment. - */ - borderRadius?: number | undefined; - /** - * Padding of the text fragment, for example: - * padding: [3, 4, 5, 6]: represents padding of [top, right, bottom, left]. - * padding: 4: represents padding: [4, 4, 4, 4]. - * padding: [3, 4]: represents padding: [3, 4, 3, 4]. - * Notice, width and height specifies the width and height of the content, without padding - */ - padding?: number | number[] | undefined; - /** - * Shadow color of the text block. - * - * @default 'transparent' - */ - shadowColor?: Color | undefined; - /** - * Show blur of the text block. - */ - shadowBlur?: number | undefined; - /** - * Shadow X offset of the text block. - */ - shadowOffsetX?: number | undefined; - /** - * Shadow Y offset of the text block. - */ - shadowOffsetY?: number | undefined; - /** - * Width of the text block. It is the width of the text by default. In most cases, there is no need to specify it. You may want to use it in some cases like make simple table or using background image (see backgroundColor). - * Notice, width and height specifies the width and height of the content, without padding. width can also be percent string, like '100%', which represents the percent of contentWidth (that is, the width without padding) of its container box. It is based on contentWidth because that each text fragment is layout based on the content box, where it makes no sense that calculating width based on outerWith in prectice. - * Notice, width and height only work when rich specified. - */ - width?: number | string | undefined; - /** - * Height of the text block. It is the width of the text by default. - * You may want to use it in some cases like using background image (see backgroundColor). - * Notice, width and height specifies the width and height of the content, without padding. - * Notice, width and height only work when rich specified. - */ - height?: number | string | undefined; - /** - * Storke color of the text. - * If set as 'auto', the color will assigned as visual color, such as series color. - * - * @default 'transparent' - */ - textBorderColor?: Color | undefined; - /** - * Storke line width of the text. - */ - textBorderWidth?: number | undefined; - /** - * Shadow color of the text itself. - * - * @default 'transparent' - */ - textShadowColor?: Color | undefined; - /** - * Shadow blue of the text itself. - */ - textShadowBlur?: number | undefined; - /** - * Shadow X offset of the text itself. - */ - textShadowOffsetX?: number | undefined; - /** - * Shadow Y offset of the text itself. - */ - textShadowOffsetY?: number | undefined; - /** - * "Rich text styles" can be defined in this rich property - * - * @see https://echarts.apache.org/en/tutorial.html#Rich%20Text - */ - rich?: RichStyle | undefined; - } - } - } -} diff --git a/types/echarts/options/line-style.d.ts b/types/echarts/options/line-style.d.ts deleted file mode 100644 index 0a2dcad61ef4290..000000000000000 --- a/types/echarts/options/line-style.d.ts +++ /dev/null @@ -1,17 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * Line style - */ - interface LineStyle { - color?: EChartOption.Color | EChartOption.Color[] | undefined; - width?: number | undefined; - type?: "solid" | "dashed" | "dotted" | undefined; - shadowBlur?: number | undefined; - shadowColor?: EChartOption.Color | undefined; - shadowOffsetX?: number | undefined; - shadowOffsetY?: number | undefined; - opacity?: number | undefined; - } - } -} diff --git a/types/echarts/options/series/bar.d.ts b/types/echarts/options/series/bar.d.ts deleted file mode 100644 index 4fb60fa4138500e..000000000000000 --- a/types/echarts/options/series/bar.d.ts +++ /dev/null @@ -1,14547 +0,0 @@ -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://echarts.apache.org/en/option.html#grid) - * with at least 1 category axis. - * - * @see https://echarts.apache.org/en/option.html#series-bar - */ - interface SeriesBar { - /** - * @default - * "bar" - * @see https://echarts.apache.org/en/option.html#series-bar.type - */ - type?: "bar" | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-bar.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.name - */ - name?: string | undefined; - - /** - * Whether to enable highlighting chart when - * [legend](https://echarts.apache.org/en/option.html#legend) - * is being hovered. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.legendHoverLink - */ - legendHoverLink?: boolean | undefined; - - /** - * The coordinate used in the series, whose options are: - * - * + `'cartesian2d'` - * - * Use a two-dimensional rectangular coordinate (also known as Cartesian - * coordinate), with - * [xAxisIndex](https://echarts.apache.org/en/option.html#series-bar.xAxisIndex) - * and - * [yAxisIndex](https://echarts.apache.org/en/option.html#series-bar.yAxisIndex) - * to assign the corresponding axis component. - * - * @default - * "cartesian2d" - * @see https://echarts.apache.org/en/option.html#series-bar.coordinateSystem - */ - coordinateSystem?: string | undefined; - - /** - * Index of - * [x axis](https://echarts.apache.org/en/option.html#xAxis) - * to combine with, which is useful for multiple x axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-bar.xAxisIndex - */ - xAxisIndex?: number | undefined; - - /** - * Index of - * [y axis](https://echarts.apache.org/en/option.html#yAxis) - * to combine with, which is useful for multiple y axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-bar.yAxisIndex - */ - yAxisIndex?: number | undefined; - - /** - * Text label of , to explain some data information about graphic - * item like value, name and so on. - * `label` is placed under `itemStyle` in ECharts 2.x. - * In ECharts 3, to make the configuration structure flatter, `label`is - * taken to be at the same level with `itemStyle`, and has `emphasis` - * as `itemStyle` does. - * - * @see https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to represent - * position of label relative to top-left corner of bounding - * box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-bar.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally and - * move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template and - * callback function. - * In either form, `\n` is supported to represent a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for example,`{@product}`refers - * the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, for - * example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * Graphic style of , `emphasis` is the style when it is highlighted, - * like being hovered by mouse, or highlighted via legend connect. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#color) - * . - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-bar.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * The bodrder color of bar. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-bar.itemStyle.barBorderColor - */ - barBorderColor?: string | undefined; - - /** - * The bodrder width of bar. defaults to have no border. - * - * @see https://echarts.apache.org/en/option.html#series-bar.itemStyle.barBorderWidth - */ - barBorderWidth?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.bar.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.itemStyle.barBorderRadius - */ - barBorderRadius?: any[] | number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.itemStyle - */ - itemStyle?: { - /** - * Bar color.. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.itemStyle.color - */ - color?: string | undefined; - - /** - * The bodrder color of bar. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.itemStyle.barBorderColor - */ - barBorderColor?: string | undefined; - - /** - * The bodrder width of bar. defaults to have no border. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.itemStyle.barBorderWidth - */ - barBorderWidth?: number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.itemStyle.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.stack - */ - stack?: string | undefined; - - /** - * The mouse style when mouse hovers on an element, the same as - * `cursor` property in `CSS`. - * - * @default - * "pointer" - * @see https://echarts.apache.org/en/option.html#series-bar.cursor - */ - cursor?: string | undefined; - - /** - * The width of the bar. Adaptive when not specified. - * - * Can be an absolute value like 40 or a percent value like '60%'. The percent is based on the calculated category width. - * - * 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://echarts.apache.org/en/option.html#series-bar.barWidth - */ - barWidth?: number | string | undefined; - - /** - * The maximum width of the bar. Adaptive when not specified. - * - * Has higer priority than barWidth. - * - * Can be an absolute value like 40 or a percent value like '60%'. The percent is based on the calculated category width. - * - * 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://echarts.apache.org/en/option.html#series-bar.barMaxWidth - */ - barMaxWidth?: number | string | undefined; - - /** - * The minimum width of the bar. In cartesian the default value is 1, otherwise the default value if null. - * - * Has higer priority than barWidth. - * - * Can be an absolute value like 40 or a percent value like ''60%''. The percent is based on the calculated category width. - * - * 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://echarts.apache.org/en/option.html#series-bar.barMinWidth - */ - barMinWidth?: number | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.barMinHeight - */ - barMinHeight?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.bar) - * - * @default - * 30% - * @see https://echarts.apache.org/en/option.html#series-bar.barGap - */ - barGap?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.barCategoryGap - */ - barCategoryGap?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.large - */ - large?: boolean | undefined; - - /** - * The threshold enabling the drawing optimization. - * - * @default - * 400 - * @see https://echarts.apache.org/en/option.html#series-bar.largeThreshold - */ - largeThreshold?: number | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-bar.progressive - */ - progressive?: number | undefined; - - /** - * If current data amount is over the threshold, "progressive rendering" - * is enabled. - * - * @default - * 3000 - * @see https://echarts.apache.org/en/option.html#series-bar.progressiveThreshold - */ - progressiveThreshold?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.progressiveChunkMode - */ - progressiveChunkMode?: string | undefined; - - /** - * `dimensions` can be used to define dimension info for `series.data` - * or `dataset.source`. - * - * Notice: if - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * is used, we can provide dimension names in the first column/row - * of - * [dataset.source](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar) - * [see doc](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.dimensions - */ - dimensions?: any[] | undefined; - - /** - * Define what is encoded to for each dimension of `data`. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar) - * - * Attributes of encode are different according to the type of coordinate - * systtems. For - * [cartesian2d](https://echarts.apache.org/en/option.html#grid) - * , `x` and `y` can be defined. For - * [polar](https://echarts.apache.org/en/option.html#polar) - * , `radius` and `angle` can be defined. For - * [geo](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#dataZoom) - * on the axis will not filter the series. - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar) - * - * @see https://echarts.apache.org/en/option.html#series-bar.encode - */ - encode?: object | undefined; - - /** - * When - * [dataset](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=dataset-series-layout-by) - * . - * - * @default - * "column" - * @see https://echarts.apache.org/en/option.html#series-bar.seriesLayoutBy - */ - seriesLayoutBy?: string | undefined; - - /** - * If - * [series.data](https://echarts.apache.org/en/option.html#series.data) - * is not specified, and - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * exists, the series will use `dataset`. - * `datasetIndex` specifies which dataset will be used. - * - * @see https://echarts.apache.org/en/option.html#series-bar.datasetIndex - */ - datasetIndex?: number | undefined; - - /** - * Data array of series, which can be in the following forms: - * - * Notice, if no `data` specified in series, and there is - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * in option, series will use the first - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * as its datasource. If `data` has been specified, - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * will not used. - * - * `series.datasetIndex` can be used to specify other - * [dataset](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar) - * - * + In - * [cartesian (grid)](https://echarts.apache.org/en/option.html#grid) - * , "dimX" and "dimY" correspond to - * [xAxis](https://echarts.apache.org/en/option.html#xAxis) - * and - * [yAxis](https://echarts.apache.org/en/option.html#yAxis) - * repectively. - * + In - * [polar](https://echarts.apache.org/en/option.html#polar) - * "dimX" and "dimY" correspond to - * [radiusAxis](https://echarts.apache.org/en/option.html#radiusAxis) - * 和 - * [angleAxis](https://echarts.apache.org/en/option.html#anbleAxis) - * repectively. - * + Other dimensions are optional, which can be used in other place. - * For example: - * + [visualMap](https://echarts.apache.org/en/option.html#visualMap) - * can map one or more dimensions to viusal (color, symbol size - * ...). - * + [series.symbolSize](https://echarts.apache.org/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://echarts.apache.org/en/option.html#tooltip.formatter) - * or - * [series.label.formatter](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar) - * - * **Relationship between "value" and - * [axis.type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar) - * - * There is an example of double category axes: - * [Github Punchcard](https://echarts.apache.org/examples/en/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.data - */ - data?: - | Array - | Array> - | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markPoint.data.x) - * , - * [y](https://echarts.apache.org/en/option.html#series-bar.markPoint.data.y) - * attribute, in which pixel values and percentage are supported. - * - * 2. Assign coordinate position with - * [coord](https://echarts.apache.org/en/option.html#series-bar.markPoint.data.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-bar.markPoint.data.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-bar.markPoint.data.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data - */ - data?: - | Array<{ - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.name - */ - name?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markPoint.data.type - */ - type?: string | undefined; - - /** - * Available when using - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markPoint.data.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markPoint.data.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.coord - */ - coord?: any[] | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - }> - | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-bar.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/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://echarts.apache.org/en/option.html#series-bar.bar.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markLine.data.1.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markLine.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markLine.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.type) - * , where - * [valueIndex](https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=scatter-weight) - * - * The priority follows as above if more than one above definition - * used. - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.1.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-bar.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * If clip the overflow on the coordinate system. Clip results varies between series: - * - * Scatter/EffectScatter：Ignore the symbols exceeds the coordinate system. Not clip the elements. - * Bar：Clip all the overflowed. With bar width kept. - * Line：Clip the overflowed line. - * Lines: Clip all the overflowed. - * Candlestick: Ignore the elements exceeds the coordinate system. - * Custom: Clip all the olverflowed. - * - * All these series have default value true except custom series. Set it to false if you don't want to clip. - * - * @see https://echarts.apache.org/en/option.html#series-bar.clip - */ - clip?: boolean | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-bar.zlevel - */ - zlevel?: number | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-bar.z - */ - z?: number | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-bar.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger than - * threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-bar.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-bar.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-bar.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-bar.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-bar.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-bar.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback function - * for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-bar.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-bar.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesBar { - interface DataObject { - /** - * The name of data item. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.name - */ - name?: string | undefined; - - /** - * The value of a single data item. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.value - */ - value?: number | undefined; - - /** - * The style setting of the text label in a single bar. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle - */ - itemStyle?: { - /** - * Bar color.. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.color - */ - color?: string | undefined; - - /** - * The bodrder color of bar. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.barBorderColor - */ - barBorderColor?: string | undefined; - - /** - * The bodrder width of bar. defaults to have no border. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.barBorderWidth - */ - barBorderWidth?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-bar.bar.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.barBorderRadius - */ - barBorderRadius?: any[] | number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.emphasis - */ - emphasis?: { - /** - * Bar color.. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.emphasis.color - */ - color?: string | undefined; - - /** - * The bodrder color of bar. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.emphasis.barBorderColor - */ - barBorderColor?: string | undefined; - - /** - * The bodrder width of bar. - * defaults to have no border. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.emphasis.barBorderWidth - */ - barBorderWidth?: number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-bar.bar.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * tooltip settings in this series data. - * - * @see https://echarts.apache.org/en/option.html#series-bar.data.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - } - } -} diff --git a/types/echarts/options/series/boxplot.d.ts b/types/echarts/options/series/boxplot.d.ts deleted file mode 100644 index ca719d218f7657e..000000000000000 --- a/types/echarts/options/series/boxplot.d.ts +++ /dev/null @@ -1,11437 +0,0 @@ -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://echarts.apache.org/en/option.html#series-boxplot) - * - * Multiple `series` can be displayed in the same coordinate system. - * Please refer to - * [this example](https://echarts.apache.org/examples/en/editor.html?c=boxplot-multi&edit=1&reset=1) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot - */ - interface SeriesBoxplot { - /** - * @default - * "boxplot" - * @see https://echarts.apache.org/en/option.html#series-boxplot.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.id - */ - id?: string | undefined; - - /** - * The coordinate used in the series, whose options are: - * - * + `'cartesian2d'` - * - * Use a two-dimensional rectangular coordinate (also known as Cartesian - * coordinate), with - * [xAxisIndex](https://echarts.apache.org/en/option.html#series-cartesian2d.xAxisIndex) - * and - * [yAxisIndex](https://echarts.apache.org/en/option.html#series-cartesian2d.yAxisIndex) - * to assign the corresponding axis component. - * - * @default - * "cartesian2d" - * @see https://echarts.apache.org/en/option.html#series-boxplot.coordinateSystem - */ - coordinateSystem?: string | undefined; - - /** - * Index of - * [x axis](https://echarts.apache.org/en/option.html#xAxis) - * to combine with, which is useful for multiple x axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.xAxisIndex - */ - xAxisIndex?: number | undefined; - - /** - * Index of - * [y axis](https://echarts.apache.org/en/option.html#yAxis) - * to combine with, which is useful for multiple y axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.yAxisIndex - */ - yAxisIndex?: number | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.name - */ - name?: string | undefined; - - /** - * Whether to enable highlighting chart when - * [legend](https://echarts.apache.org/en/option.html#legend) - * is being hovered. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.legendHoverLink - */ - legendHoverLink?: boolean | undefined; - - /** - * Whether to enable the animation when hovering on box. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.hoverAnimation - */ - hoverAnimation?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.layout - */ - layout?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.boxWidth - */ - boxWidth?: any[] | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle - */ - itemStyle?: { - /** - * boxplot color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides single - * colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.itemStyle) - * - * @default - * "#fff" - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * boxplot border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * boxplot border width. No border when it is set to be 0. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle - */ - itemStyle?: { - /** - * boxplot color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides - * single colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.emphasis.itemStyle) - * - * @default - * "#fff" - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * boxplot border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * boxplot border width. - * No border when it is set to be 0. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.emphasis.itemStyle) - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @default - * "rgba(0,0,0,0.4)" - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * `dimensions` can be used to define dimension info for `series.data` - * or `dataset.source`. - * - * Notice: if - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * is used, we can provide dimension names in the first column/row - * of - * [dataset.source](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot) - * [see doc](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.dimensions - */ - dimensions?: any[] | undefined; - - /** - * Define what is encoded to for each dimension of `data`. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot) - * - * Attributes of encode are different according to the type of coordinate - * systtems. For - * [cartesian2d](https://echarts.apache.org/en/option.html#grid) - * , `x` and `y` can be defined. For - * [polar](https://echarts.apache.org/en/option.html#polar) - * , `radius` and `angle` can be defined. For - * [geo](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#dataZoom) - * on the axis will not filter the series. - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.encode - */ - encode?: object | undefined; - - /** - * Data should be the two-dimensional array shown as follow. - * - * [see doc](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=boxplot-light-velocity&edit=1&reset=1) - * uses `echarts.dataTool.prepareBoxplotData` - * to proceed simple data statistics. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data - */ - data?: Array> | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.x) - * , - * [y](https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.y) - * attribute, in which pixel values and percentage are supported. - * - * 2. Assign coordinate position with - * [coord](https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data - */ - data?: { - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.name - */ - name?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.type - */ - type?: string | undefined; - - /** - * Available when using - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.coord - */ - coord?: any[] | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Position according to X-Axis value. - * For a line parallel to Y-Axis - */ - xAxis?: number | undefined; - - /** - * Position according to Y-Axis value - * For a line parallel to X-Axis - */ - yAxis?: number | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Position according to X-Axis value. - * For a line parallel to Y-Axis - */ - xAxis?: number | undefined; - - /** - * Position according to Y-Axis value - * For a line parallel to X-Axis - */ - yAxis?: number | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.type) - * , where - * [valueIndex](https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=scatter-weight) - * - * The priority follows as above if more than one above definition - * used. - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-boxplot.zlevel - */ - zlevel?: number | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-boxplot.z - */ - z?: number | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to mouse - * events. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.silent - */ - silent?: boolean | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot) - * - * @default - * 800 - * @see https://echarts.apache.org/en/option.html#series-boxplot.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "elasticOut" - * @see https://echarts.apache.org/en/option.html#series-boxplot.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesBoxplot { - interface DataObject { - /** - * Name of data item. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.name - */ - name?: string | undefined; - - /** - * Value of data item. - * - * ``` - * [min, Q1, median (or Q2), Q3, max] - * - * ``` - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.value - */ - value?: any[] | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle - */ - itemStyle?: { - /** - * boxplot color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides - * single colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.data.itemStyle) - * - * @default - * "#fff" - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * boxplot border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * boxplot border width. - * No border when it is set to be 0. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle - */ - itemStyle?: { - /** - * boxplot color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for - * example `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example - * `'#ccc'`. - * Gradient color and texture are also supported besides - * single colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.data.emphasis.itemStyle) - * - * @default - * "#fff" - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * boxplot border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * boxplot border width. - * No border when it is set to be 0. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-boxplot.boxplot.data.emphasis.itemStyle) - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @default - * "rgba(0,0,0,0.4)" - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * tooltip settings in this series data. - * - * @see https://echarts.apache.org/en/option.html#series-boxplot.data.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - } - } -} diff --git a/types/echarts/options/series/candlestick.d.ts b/types/echarts/options/series/candlestick.d.ts deleted file mode 100644 index 71e4e5889e1aff0..000000000000000 --- a/types/echarts/options/series/candlestick.d.ts +++ /dev/null @@ -1,11665 +0,0 @@ -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://echarts.apache.org/en/option.html#(series.type) - * (`'k'` would automatically turns into `'candlestick'`). - * - * **An example:** - * - * [see doc](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.itemStyle.color) - * : fill color for bullish candle stick (namely, increase) - * + [series-candlestick.itemStyle.color0](https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.color0) - * : fill color for bearish candle stick (namely, decrease) - * + [series-candlestick.itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.borderColor) - * : border color for bullish candle stick (namely, increase) - * + [series-candlestick.itemStyle.borderColor0](https://echarts.apache.org/en/option.htmlseries-candlestick.itemStyle.borderColor0) - * : border color for bearish candle stick (namely, decrease) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick - */ - interface SeriesCandlestick { - /** - * @default - * "candlestick" - * @see https://echarts.apache.org/en/option.html#series-candlestick.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.id - */ - id?: string | undefined; - - /** - * The coordinate used in the series, whose options are: - * - * + `'cartesian2d'` - * - * Use a two-dimensional rectangular coordinate (also known as Cartesian - * coordinate), with - * [xAxisIndex](https://echarts.apache.org/en/option.html#series-cartesian2d.xAxisIndex) - * and - * [yAxisIndex](https://echarts.apache.org/en/option.html#series-cartesian2d.yAxisIndex) - * to assign the corresponding axis component. - * - * @default - * "cartesian2d" - * @see https://echarts.apache.org/en/option.html#series-candlestick.coordinateSystem - */ - coordinateSystem?: string | undefined; - - /** - * Index of - * [x axis](https://echarts.apache.org/en/option.html#xAxis) - * to combine with, which is useful for multiple x axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.xAxisIndex - */ - xAxisIndex?: number | undefined; - - /** - * Index of - * [y axis](https://echarts.apache.org/en/option.html#yAxis) - * to combine with, which is useful for multiple y axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.yAxisIndex - */ - yAxisIndex?: number | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.name - */ - name?: string | undefined; - - /** - * Whether to enable highlighting chart when - * [legend](https://echarts.apache.org/en/option.html#legend) - * is being hovered. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.legendHoverLink - */ - legendHoverLink?: boolean | undefined; - - /** - * Whether to enable animitation when hovering on box. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.hoverAnimation - */ - hoverAnimation?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.layout - */ - layout?: string | undefined; - - /** - * Specify bar width. - * Absolute value (like `10`) or percentage (like `'20%'`, according - * to band width) can be used. Auto adapt by default. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.barWidth - */ - barWidth?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.barMinWidth - */ - barMinWidth?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.barMaxWidth - */ - barMaxWidth?: number | undefined; - - /** - * Item style of candlestick. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.itemStyle) - * - * @default - * "#c23531" - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.itemStyle) - * - * @default - * #314656 - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.color0 - */ - color0?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.itemStyle) - * - * @default - * "#c23531" - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.itemStyle) - * - * @default - * #314656 - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.borderColor0 - */ - borderColor0?: string | undefined; - - /** - * Border width of candlestick. - * There is no border when it is `0`. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * Emphasis style of candlestick. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) - * - * @default - * "#c23531" - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) - * - * @default - * #314656 - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.color0 - */ - color0?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) - * - * @default - * "#c23531" - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) - * - * @default - * #314656 - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.borderColor0 - */ - borderColor0?: string | undefined; - - /** - * Border width of candlestick. - * There is no border when it is `0`. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.large - */ - large?: boolean | undefined; - - /** - * The threshold enabling the drawing optimization. - * - * @default - * 600 - * @see https://echarts.apache.org/en/option.html#series-candlestick.largeThreshold - */ - largeThreshold?: number | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-candlestick.progressive - */ - progressive?: number | undefined; - - /** - * If current data amount is over the threshold, "progressive rendering" - * is enabled. - * - * @default - * 10000 - * @see https://echarts.apache.org/en/option.html#series-candlestick.progressiveThreshold - */ - progressiveThreshold?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.progressiveChunkMode - */ - progressiveChunkMode?: string | undefined; - - /** - * `dimensions` can be used to define dimension info for `series.data` - * or `dataset.source`. - * - * Notice: if - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * is used, we can provide dimension names in the first column/row - * of - * [dataset.source](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick) - * [see doc](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.dimensions - */ - dimensions?: any[] | undefined; - - /** - * Define what is encoded to for each dimension of `data`. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick) - * - * Attributes of encode are different according to the type of coordinate - * systtems. For - * [cartesian2d](https://echarts.apache.org/en/option.html#grid) - * , `x` and `y` can be defined. For - * [polar](https://echarts.apache.org/en/option.html#polar) - * , `radius` and `angle` can be defined. For - * [geo](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#dataZoom) - * on the axis will not filter the series. - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.encode - */ - encode?: object | undefined; - - /** - * Data should be the two-dimensional array shown as follow. - * - * [see doc](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data - */ - data?: Array> | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.x) - * , - * [y](https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.y) - * attribute, in which pixel values and percentage are supported. - * - * 2. Assign coordinate position with - * [coord](https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data - */ - data?: { - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.name - */ - name?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.type - */ - type?: string | undefined; - - /** - * Available when using - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.coord - */ - coord?: any[] | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Markline at x at given value, which only works for single data item. Example: - * data: [{ - * name: 'A vertical line with X valued 100', - * xAxis: 100 - * }] - * or if xAxis is in 'time' type, it can be set as: - * [{ - * name: 'A vertical line with X valued "2020-01-01"', - * xAxis: '2020-01-01' - * }] - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.xAxis - */ - xAxis?: number | string | undefined; - - /** - * Markline at y at given value, which only works for single data item. Example: - * data: [{ - * name: 'A horizontal line with X valued 100', - * yAxis: 100 - * }] - * or if yAxis is in 'time' type, it can be set as: - * [{ - * name: 'A horizontal line with Y valued "2020-01-01"', - * yAxis: '2020-01-01' - * }] - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.yAxis - */ - yAxis?: number | string | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.type) - * , where - * [valueIndex](https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=scatter-weight) - * - * The priority follows as above if more than one above definition - * used. - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-candlestick.zlevel - */ - zlevel?: number | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-candlestick.z - */ - z?: number | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to mouse - * events. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.silent - */ - silent?: boolean | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-candlestick.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "linear" - * @see https://echarts.apache.org/en/option.html#series-candlestick.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesCandlestick { - interface DataObject { - /** - * Name of data item. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.name - */ - name?: string | undefined; - - /** - * Value of data item. - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.data) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.value - */ - value?: any[] | undefined; - - /** - * Style of a candle box. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.itemStyle) - * - * @default - * "#c23531" - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.itemStyle) - * - * @default - * #314656 - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.color0 - */ - color0?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.itemStyle) - * - * @default - * "#c23531" - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.itemStyle) - * - * @default - * #314656 - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.borderColor0 - */ - borderColor0?: string | undefined; - - /** - * Border width of candlestick. - * There is no border when it is `0`. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * Emphasis style of a candle box. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) - * - * @default - * "#c23531" - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) - * - * @default - * #314656 - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.color0 - */ - color0?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) - * - * @default - * "#c23531" - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) - * - * @default - * #314656 - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.borderColor0 - */ - borderColor0?: string | undefined; - - /** - * Border width of candlestick. - * There is no border when it is `0`. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * tooltip settings in this series data. - * - * @see https://echarts.apache.org/en/option.html#series-candlestick.data.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - } - } -} diff --git a/types/echarts/options/series/custom.d.ts b/types/echarts/options/series/custom.d.ts deleted file mode 100644 index b248ffbea9477ea..000000000000000 --- a/types/echarts/options/series/custom.d.ts +++ /dev/null @@ -1,6821 +0,0 @@ -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://echarts.apache.org/en/option.html#dataZoom) - * 、 - * [visualMap](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom) - * - * ** - * [More samples of custom series](https://echarts.apache.org/examples/en/index.html#chart-type-custom) - * ** - * - * ** - * [A tutotial of custom series](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem) - * . - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom) - * - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * will be called on each data item. - * - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * provides two parameters: - * - * + [params](https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.params) - * : provides info about the current series and data and coordinate - * system. - * + [api](https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api) - * : includes some methods. - * - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * method should returns graphic elements definitions.See - * [renderItem.return](https://echarts.apache.org/en/option.html#series-custom.renderItem.return) - * . - * - * Generally, the main process of - * [renderItem](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api) - * are always used in this procedure: - * - * + [api.value(...)](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom) - * - * **Controlled by dataZoom** - * - * When use `custom series` with - * [dataZoom](https://echarts.apache.org/en/option.html#dataZoom) - * , - * [dataZoom.filterMode](https://echarts.apache.org/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://echarts.apache.org/en/option.html#dataZoom) - * . - * - * [renderItem.arguments.api](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom) - * - * @see https://echarts.apache.org/en/option.html#series-custom - */ - interface SeriesCustom { - /** - * @default - * "custom" - * @see https://echarts.apache.org/en/option.html#series-custom.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-custom.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-custom.name - */ - name?: string | undefined; - - /** - * Whether to enable highlighting chart when - * [legend](https://echarts.apache.org/en/option.html#legend) - * is being hovered. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-custom.legendHoverLink - */ - legendHoverLink?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.xAxisIndex) - * and - * [yAxisIndex](https://echarts.apache.org/en/option.html#series-custom.yAxisIndex) - * to assign the corresponding axis component. - * - * + `'polar'` - * - * Use polar coordinates, with - * [polarIndex](https://echarts.apache.org/en/option.html#series-custom.polarIndex) - * to assign the corresponding polar coordinate component. - * - * + `'geo'` - * - * Use geographic coordinate, with - * [geoIndex](https://echarts.apache.org/en/option.html#series-custom.geoIndex) - * to assign the corresponding geographic coordinate components. - * - * + `'none'` - * - * Do not use coordinate system. - * - * @default - * "cartesian2d" - * @see https://echarts.apache.org/en/option.html#series-custom.coordinateSystem - */ - coordinateSystem?: string | undefined; - - /** - * Index of - * [x axis](https://echarts.apache.org/en/option.html#xAxis) - * to combine with, which is useful for multiple x axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-custom.xAxisIndex - */ - xAxisIndex?: number | undefined; - - /** - * Index of - * [y axis](https://echarts.apache.org/en/option.html#yAxis) - * to combine with, which is useful for multiple y axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-custom.yAxisIndex - */ - yAxisIndex?: number | undefined; - - /** - * Index of - * [polar coordinate](https://echarts.apache.org/en/option.html#polar) - * to combine with, which is useful for multiple polar axes in one - * chart. - * - * @see https://echarts.apache.org/en/option.html#series-custom.polarIndex - */ - polarIndex?: number | undefined; - - /** - * Index of - * [geographic coordinate](https://echarts.apache.org/en/option.html#geo) - * to combine with, which is useful for multiple geographic axes - * in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-custom.geoIndex - */ - geoIndex?: number | undefined; - - /** - * Index of - * [calendar coordinates](https://echarts.apache.org/en/option.html#calendar) - * to combine with, which is useful for multiple calendar coordinates - * in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-custom.calendarIndex - */ - calendarIndex?: number | undefined; - - /** - * `custom series` requires developers to write a render logic by - * themselves. This render logic is called - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * . - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom) - * - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * will be called on each data item. - * - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * provides two parameters: - * - * + [params](https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.params) - * : provides info about the current series and data and coordinate - * system. - * + [api](https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api) - * : includes some methods. - * - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * method should returns graphic elements definitions.See - * [renderItem.return](https://echarts.apache.org/en/option.html#series-custom.renderItem.return) - * . - * - * Generally, the main process of - * [renderItem](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api) - * are always used in this procedure: - * - * + [api.value(...)](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem - * - * @returns - * `renderItem` should returns graphic element definitions. - * Each graphic element is an object. See - * [graphic](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom.renderItem) - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return - */ - renderItem?: SeriesCustom.RenderItem | undefined; - - /** - * Graphic style of , `emphasis` is the style when it is highlighted, - * like being hovered by mouse, or highlighted via legend connect. - * - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle - */ - itemStyle?: { - /** - * color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides single - * colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-custom.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-custom.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * `dimensions` can be used to define dimension info for `series.data` - * or `dataset.source`. - * - * Notice: if - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * is used, we can provide dimension names in the first column/row - * of - * [dataset.source](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom) - * [see doc](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.dimensions - */ - dimensions?: any[] | undefined; - - /** - * Define what is encoded to for each dimension of `data`. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom) - * - * Attributes of encode are different according to the type of coordinate - * systtems. For - * [cartesian2d](https://echarts.apache.org/en/option.html#grid) - * , `x` and `y` can be defined. For - * [polar](https://echarts.apache.org/en/option.html#polar) - * , `radius` and `angle` can be defined. For - * [geo](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#dataZoom) - * on the axis will not filter the series. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom) - * - * @see https://echarts.apache.org/en/option.html#series-custom.encode - */ - encode?: object | undefined; - - /** - * When - * [dataset](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=dataset-series-layout-by) - * . - * - * @default - * "column" - * @see https://echarts.apache.org/en/option.html#series-custom.seriesLayoutBy - */ - seriesLayoutBy?: string | undefined; - - /** - * If - * [series.data](https://echarts.apache.org/en/option.html#series.data) - * is not specified, and - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * exists, the series will use `dataset`. - * `datasetIndex` specifies which dataset will be used. - * - * @see https://echarts.apache.org/en/option.html#series-custom.datasetIndex - */ - datasetIndex?: number | undefined; - - /** - * Data array of series, which can be in the following forms: - * - * Notice, if no `data` specified in series, and there is - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * in option, series will use the first - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * as its datasource. If `data` has been specified, - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * will not used. - * - * `series.datasetIndex` can be used to specify other - * [dataset](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom) - * - * + In - * [cartesian (grid)](https://echarts.apache.org/en/option.html#grid) - * , "dimX" and "dimY" correspond to - * [xAxis](https://echarts.apache.org/en/option.html#xAxis) - * and - * [yAxis](https://echarts.apache.org/en/option.html#yAxis) - * repectively. - * + In - * [polar](https://echarts.apache.org/en/option.html#polar) - * "dimX" and "dimY" correspond to - * [radiusAxis](https://echarts.apache.org/en/option.html#radiusAxis) - * 和 - * [angleAxis](https://echarts.apache.org/en/option.html#anbleAxis) - * repectively. - * + Other dimensions are optional, which can be used in other place. - * For example: - * + [visualMap](https://echarts.apache.org/en/option.html#visualMap) - * can map one or more dimensions to viusal (color, symbol size - * ...). - * + [series.symbolSize](https://echarts.apache.org/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://echarts.apache.org/en/option.html#tooltip.formatter) - * or - * [series.label.formatter](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom) - * - * **Relationship between "value" and - * [axis.type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom) - * - * There is an example of double category axes: - * [Github Punchcard](https://echarts.apache.org/examples/en/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.data - */ - data?: - | Array - | Array> - | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-custom.zlevel - */ - zlevel?: number | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-custom.z - */ - z?: number | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to mouse - * events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.silent - */ - silent?: boolean | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-custom.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger than - * threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-custom.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-custom.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-custom.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-custom.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-custom.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-custom.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback function - * for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-custom.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-custom.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesCustom { - interface DataObject { - /** - * Name of data item. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.name - */ - name?: string | undefined; - - /** - * Value of data item. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.value - */ - value?: number | number[] | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-custom.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-custom.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * tooltip settings in this series data. - * - * @see https://echarts.apache.org/en/option.html#series-custom.data.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - /** - * `custom series` requires developers to write a render logic by - * themselves. This render logic is called - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * . - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom) - * - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * will be called on each data item. - * - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * provides two parameters: - * - * + [params](https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.params) - * : provides info about the current series and data and coordinate - * system. - * + [api](https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api) - * : includes some methods. - * - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * method should returns graphic elements definitions.See - * [renderItem.return](https://echarts.apache.org/en/option.html#series-custom.renderItem.return) - * . - * - * Generally, the main process of - * [renderItem](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api) - * are always used in this procedure: - * - * + [api.value(...)](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem - */ - interface RenderItem { - (params: RenderItemParams, api: RenderItemApi): - | RenderItemReturnGroup - | RenderItemReturnPath - | RenderItemReturnImage - | RenderItemReturnText - | RenderItemReturnRect - | RenderItemReturnCircle - | RenderItemReturnRing - | RenderItemReturnSector - | RenderItemReturnArc - | RenderItemReturnPolygon - | RenderItemReturnPolyline - | RenderItemReturnLine - | RenderItemReturnBezierCurve; - } - - /** - * The first parameter of `renderItem`, including: - * - * [see doc](https://echarts.apache.org/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://echarts.apache.org/en/option.html#dataZoom) - * . - * - * [renderItem.arguments.api](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.params - */ - interface RenderItemParams { - /** - * An object that developers can store something temporarily here. Life cycle: current round of rendering. - */ - context?: Record | undefined; - - /** - * The id of this series. - */ - seriesId?: string | undefined; - - /** - * The name of this series. - */ - seriesName?: string | undefined; - - /** - * The index of this series. - */ - seriesIndex?: number | undefined; - - /** - * The index of this data item. - */ - dataIndex?: number | undefined; - - /** - * The index of this data item in the current data window (see dataZoom). - */ - dataIndexInside?: number | undefined; - - /** - * The count of data in the current data window (see dataZoom). - */ - dataInsideLength?: number | undefined; - - /** - * The type of action that trigger this render. - */ - actionType?: string | undefined; - - /** - * coordSys is variable by different types of coordinate systems. - */ - coordSys?: CoordSys | undefined; - } - - /** - * The second parameter of `renderItem`. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api - */ - interface RenderItemApi { - /** - * Get value on the given dimension. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.arguments.api) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.value - */ - value?: Function | undefined; - - /** - * Convert data to coordinate. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.arguments.api) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.coord - */ - coord?: Function | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.custom.renderItem.arguments.api) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.size - */ - size?: Function | undefined; - - /** - * The method obtains style info defined in - * [series.itemStyle](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom.renderItem.arguments.api) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.style - */ - style?: Function | undefined; - - /** - * The method obtains style info defined in - * [series.itemStyle.emphasis](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.custom.renderItem.arguments.api) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.styleEmphasis - */ - styleEmphasis?: Function | undefined; - - /** - * Get the visual info. It is rarely be used. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.arguments.api) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.visual - */ - visual?: Function | undefined; - - /** - * 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://echarts.apache.org/examples/en/editor.html?c=custom-bar-trend) - * . - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.arguments.api) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.barLayout - */ - barLayout?: Function | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.currentSeriesIndices - */ - currentSeriesIndices?: Function | undefined; - - /** - * Obtain font string, which can be used on style setting - * directly. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.arguments.api) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.font - */ - font?: Function | undefined; - - /** - * ``` - * @return {number} Width of echarts containter. - * - * ``` - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.getWidth - */ - getWidth?: Function | undefined; - - /** - * ``` - * @return {number} Height of echarts container. - * - * ``` - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.getHeight - */ - getHeight?: Function | undefined; - - /** - * ``` - * @return {module:zrender} zrender instance. - * - * ``` - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.getZr - */ - getZr?: Function | undefined; - - /** - * ``` - * @return {number} The current devicePixelRatio。 - * - * ``` - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.arguments.api.getDevicePixelRatio - */ - getDevicePixelRatio?: Function | undefined; - } - - /** - * coordSys is variable by different types of coordinate systems. - */ - interface CoordSys { - type?: "cartesian2d" | "calendar" | "geo" | "polar" | "singleAxis" | undefined; - - /** - * x of grid rect, calendar rect, geo rect or singleAxis rect - * - * It is not valid when type is 'polar' - */ - x?: number | undefined; - - /** - * y of grid rect, calendar rect, geo rect or singleAxis rect - * - * It is not valid when type is 'polar' - */ - y?: number | undefined; - - /** - * width of grid rect, calendar rect, geo rect or singleAxis rect - * - * It is not valid when type is 'polar' - */ - width?: number | undefined; - - /** - * height of grid rect, calendar rect, geo rect or singleAxis rect - * - * It is not valid when type is 'polar' - */ - height?: number | undefined; - - // calendar cellWidth - - /** - * calendar cellWidth - * - * It is valid when type is 'calendar' - */ - cellWidth?: number | undefined; - - /** - * calendar cellHeight - * - * It is valid when type is 'calendar' - */ - cellHeight?: number | undefined; - - /** - * calendar rangeInfo - * - * It is valid when type is 'calendar' - */ - rangeInfo?: RangeInfo | undefined; - - /** - * zoom ratio, 1 if no zoom, 0.5 means shrink to 50%. - * - * It is valid when type is 'geo' - */ - zoom?: number | undefined; - - /** - * x of polar center. - * - * It is valid when type is 'polar' - */ - cx?: number | undefined; - - /** - * y of polar center. - * - * It is valid when type is 'polar' - */ - cy?: number | undefined; - - /** - * outer radius of polar. - * - * It is valid when type is 'polar' - */ - r?: number | undefined; - - /** - * inner radius of polar. - * - * It is valid when type is 'polar' - */ - r0?: number | undefined; - } - - /** - * calendar rangeInfo - */ - interface RangeInfo { - /** - * date start of calendar. - */ - start?: any; - - /** - * date end of calendar. - */ - end?: any; - - /** - * number of weeks in calendar. - */ - weeks?: number | undefined; - - /** - * day count in calendar. - */ - dayCount?: number | undefined; - } - - /** - * `group` is the only type that can contain children, so that - * a group of elements can be positioned and transformed together. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group - */ - interface RenderItemReturnGroup { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional value - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "group" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_group) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.ignore - */ - ignore?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.width - */ - width?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.height - */ - height?: number | undefined; - - /** - * In - * [custom series](https://echarts.apache.org/en/option.html#series-custom) - * , when `diffChildrenByName` is set as `true`, for each - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * returned from - * [renderItem](https://echarts.apache.org/en/option.html#series-custom.renderItem) - * , "diff" will be performed to its - * [children](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.children) - * according to the - * [name](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.diffChildrenByName - */ - diffChildrenByName?: boolean | undefined; - - /** - * A list of children, each item is a declaration of an - * element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.children - */ - children?: any[] | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * 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://echarts.apache.org/examples/en/editor.html?c=custom-calendar-icon) - * and - * [shapes](https://echarts.apache.org/examples/en/editor.html?c=custom-gantt-flight) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path - */ - interface RenderItemReturnPath { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "path" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_path) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.width) - * , - * [height](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.height) - * , - * [x](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.x) - * and - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.layout) - * can be used to specify the transform strategy. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.pathData - */ - pathData?: string | undefined; - - /** - * Alias of - * [pathData](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.pathData) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.d - */ - d?: string | undefined; - - /** - * If - * [width](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.width) - * , - * [height](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.height) - * , - * [x](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.x) - * and - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.layout - */ - layout?: string | undefined; - - /** - * The x value of the left-top corner of the element - * in the coordinate system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.x - */ - x?: number | undefined; - - /** - * The y value of the left-top corner of the element - * in the coordinate system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.y - */ - y?: number | undefined; - - /** - * The width of the shape of the element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.width - */ - width?: number | undefined; - - /** - * The height of the shape of the element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.shape.height - */ - height?: number | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.style - */ - style?: { - /** - * Color filled in this element. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_path.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image - */ - interface RenderItemReturnImage { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "image" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_image) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.image - */ - image?: string | undefined; - - /** - * The x value of the left-top corner of the element - * in the coordinate system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.x - */ - x?: number | undefined; - - /** - * The y value of the left-top corner of the element - * in the coordinate system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.y - */ - y?: number | undefined; - - /** - * The width of the shape of the element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.width - */ - width?: number | undefined; - - /** - * The height of the shape of the element. - * - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.height - */ - height?: number | undefined; - - /** - * Color filled in this element. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Text block. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text - */ - interface RenderItemReturnText { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "text" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_text) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style - */ - style?: { - /** - * Text content. `\n` can be used as a line break. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.text - */ - text?: string | undefined; - - /** - * The x value of the left-top corner of the element - * in the coordinate system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.x - */ - x?: number | undefined; - - /** - * The y value of the left-top corner of the element - * in the coordinate system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.y - */ - y?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_text.style) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.font - */ - font?: string | undefined; - - /** - * Text horizontal alignment. - * Optional values: `'left'`, `'center'`, `'right'`. - * - * `'left'` means the left side of the text block is - * specified by the - * [style.x](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.y) - * . - * - * @default - * "left" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.textAlign - */ - textAlign?: string | undefined; - - /** - * Text vertical alignment. - * Optional values: `'top'`, `'middle'`, `'bottom'`. - * - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.textVerticalAlign - */ - textVerticalAlign?: string | undefined; - - /** - * Color filled in this element. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Rectangle element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect - */ - interface RenderItemReturnRect { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "rect" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_rect) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.shape.x - */ - x?: number | undefined; - - /** - * The y value of the left-top corner of the element - * in the coordinate system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.shape.y - */ - y?: number | undefined; - - /** - * The width of the shape of the element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.shape.width - */ - width?: number | undefined; - - /** - * The height of the shape of the element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.shape.height - */ - height?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.shape.r - */ - r?: any[] | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.style - */ - style?: { - /** - * Color filled in this element. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Circle element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle - */ - interface RenderItemReturnCircle { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "circle" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_circle) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.shape.cx - */ - cx?: number | undefined; - - /** - * The y value of the center of the element in the coordinate - * system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.shape.cy - */ - cy?: number | undefined; - - /** - * Outside radius. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.shape.r - */ - r?: number | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.style - */ - style?: { - /** - * Color filled in this element. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Ring element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring - */ - interface RenderItemReturnRing { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "ring" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_ring) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.shape.cx - */ - cx?: number | undefined; - - /** - * The y value of the center of the element in the coordinate - * system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.shape.cy - */ - cy?: number | undefined; - - /** - * Outside radius. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.shape.r - */ - r?: number | undefined; - - /** - * Inside radius. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.shape.r0 - */ - r0?: number | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.style - */ - style?: { - /** - * Color filled in this element. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Sector element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector - */ - interface RenderItemReturnSector { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "sector" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_sector) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.shape.cx - */ - cx?: number | undefined; - - /** - * The y value of the center of the element in the coordinate - * system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.shape.cy - */ - cy?: number | undefined; - - /** - * Outside radius. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.shape.r - */ - r?: number | undefined; - - /** - * Inside radius. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.shape.r0 - */ - r0?: number | undefined; - - /** - * start angle, in radian. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.shape.startAngle - */ - startAngle?: number | undefined; - - /** - * end anble, in radian. - * - * @default - * "Math.PI * 2" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.shape.endAngle - */ - endAngle?: number | undefined; - - /** - * Whether draw clockwise. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.shape.clockwise - */ - clockwise?: boolean | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.style - */ - style?: { - /** - * Color filled in this element. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Arc element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc - */ - interface RenderItemReturnArc { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "arc" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_arc) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.shape.cx - */ - cx?: number | undefined; - - /** - * The y value of the center of the element in the coordinate - * system of its parent. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.shape.cy - */ - cy?: number | undefined; - - /** - * Outside radius. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.shape.r - */ - r?: number | undefined; - - /** - * Inside radius. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.shape.r0 - */ - r0?: number | undefined; - - /** - * start angle, in radian. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.shape.startAngle - */ - startAngle?: number | undefined; - - /** - * end anble, in radian. - * - * @default - * "Math.PI * 2" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.shape.endAngle - */ - endAngle?: number | undefined; - - /** - * Whether draw clockwise. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.shape.clockwise - */ - clockwise?: boolean | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.style - */ - style?: { - /** - * Color filled in this element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Polygon element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon - */ - interface RenderItemReturnPolygon { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "polygon" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_polygon) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.shape.points - */ - points?: any[] | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.shape.smooth - */ - smooth?: number | string | undefined; - - /** - * Whether prevent the smooth process cause the line - * out of the bounding box. - * - * Only works when `smooth` is `number` (bezier smooth). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.shape.smoothConstraint - */ - smoothConstraint?: boolean | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style - */ - style?: { - /** - * Color filled in this element. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Polyline element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline - */ - interface RenderItemReturnPolyline { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "polyline" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_polyline) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.shape.points - */ - points?: any[] | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.shape.smooth - */ - smooth?: number | string | undefined; - - /** - * Whether prevent the smooth process cause the line - * out of the bounding box. - * - * Only works when `smooth` is `number` (bezier smooth). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.shape.smoothConstraint - */ - smoothConstraint?: boolean | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.style - */ - style?: { - /** - * Color filled in this element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Line element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line - */ - interface RenderItemReturnLine { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "line" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_line) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.shape - */ - shape?: { - /** - * x value of the start point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.shape.x1 - */ - x1?: number | undefined; - - /** - * y value of the start point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.shape.y1 - */ - y1?: number | undefined; - - /** - * x value of the end point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.shape.x2 - */ - x2?: number | undefined; - - /** - * y value of the end point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.shape.y2 - */ - y2?: number | undefined; - - /** - * Specify the percentage of drawing, useful in animation. - * - * Value range: \[0, 1\]. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.shape.percent - */ - percent?: number | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.style - */ - style?: { - /** - * Color filled in this element. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - - /** - * Quadratic bezier curve or cubic bezier curve. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve - */ - interface RenderItemReturnBezierCurve { - /** - * Must be specified when define a graphic element at the - * first time. - * - * Optional values: - * - * [image](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_image) - * , - * [text](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_text) - * , - * [circle](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_circle) - * , - * [sector](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_sector) - * , - * [ring](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_ring) - * , - * [polygon](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon) - * , - * [polyline](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polyline) - * , - * [rect](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_rect) - * , - * [line](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_line) - * , - * [bezierCurve](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve) - * , - * [arc](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_arc) - * , - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * , - * - * @default - * "bezierCurve" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.type - */ - type?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.id - */ - id?: string | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.position - */ - position?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.rotation - */ - rotation?: number | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.scale - */ - scale?: any[] | undefined; - - /** - * `2D transform` can be applied to graphic elements, including: - * - * + [position](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.rotation) - * : Rotation in radian, `0` by default. - * Positive when anticlockwise. - * + [scale](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.scale) - * : `[horizontal scale factor, vertical scale factor]`, - * `[1, 1]` by default. - * - * [origin](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * or the root canvas). Thus we are able to - * [group](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_group) - * multiple elements, and - * [groups](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.origin - */ - origin?: number | undefined; - - /** - * Define the overlap relationship between graphic elements. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.z2 - */ - z2?: number | undefined; - - /** - * See - * [diffChildrenByName](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) - * 。 - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.name - */ - name?: string | undefined; - - /** - * User defined data, can be visited in event listeners. - * - * [see doc](https://echarts.apache.org/en/option.html#series-custom.custom.renderItem.return_bezierCurve) - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.info - */ - info?: any; - - /** - * Whether response to mouse events / touch events. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.silent - */ - silent?: boolean | undefined; - - /** - * Whether the element is visible. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.invisible - */ - invisible?: boolean | undefined; - - /** - * Whether the element is totally ignored (neither render - * nor listen events). - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.ignore - */ - ignore?: boolean | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape - */ - shape?: { - /** - * x value of the start point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape.x1 - */ - x1?: number | undefined; - - /** - * y value of the start point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape.y1 - */ - y1?: number | undefined; - - /** - * x value of the end point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape.x2 - */ - x2?: number | undefined; - - /** - * y value of the end point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape.y2 - */ - y2?: number | undefined; - - /** - * x of control point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape.cpx1 - */ - cpx1?: number | undefined; - - /** - * y of control point. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape.cpy1 - */ - cpy1?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape.cpx2 - */ - cpx2?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape.cpy2 - */ - cpy2?: number | undefined; - - /** - * Specify the percentage of drawing, useful in animation. - * - * Value range: \[0, 1\]. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.shape.percent - */ - percent?: number | undefined; - } | undefined; - - /** - * More attributes in `style` (for example, - * [rich text](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.fill` - * + [itemStyle.borderColor](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.stroke` - * + [label.color](https://echarts.apache.org/en/option.html#series-scatter.label.color) - * => `style.textFill` - * + [label.textBorderColor](https://echarts.apache.org/en/option.html#series-scatter.label.textBorderColor) - * => `style.textStroke` - * + ... - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.style - */ - style?: { - /** - * Color filled in this element. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.style.fill - */ - fill?: string | undefined; - - /** - * Color of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.style.stroke - */ - stroke?: string | undefined; - - /** - * Width of stroke. - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.style.lineWidth - */ - lineWidth?: number | undefined; - - /** - * Width of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.style.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * X offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.style.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Y offset of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.style.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * color of shadow. - * - * @default - * "undefined" - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.style.shadowColor - */ - shadowColor?: number | undefined; - } | undefined; - - /** - * Empahsis style of the graphic element, whose structure - * is the same as - * [style](https://echarts.apache.org/en/option.html#series-custom.renderItem.return_polygon.style) - * . - * - * @see https://echarts.apache.org/en/option.html#series-custom.renderItem.return_bezierCurve.styleEmphasis - */ - styleEmphasis?: object | undefined; - } - } - } -} diff --git a/types/echarts/options/series/effect-scatter.d.ts b/types/echarts/options/series/effect-scatter.d.ts deleted file mode 100644 index c270a161603b7e8..000000000000000 --- a/types/echarts/options/series/effect-scatter.d.ts +++ /dev/null @@ -1,14694 +0,0 @@ -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://echarts.apache.org/en/option.html#series-effectScatter) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter - */ - interface SeriesEffectScatter { - /** - * @default - * "effectScatter" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.name - */ - name?: string | undefined; - - /** - * Whether to enable highlighting chart when - * [legend](https://echarts.apache.org/en/option.html#legend) - * is being hovered. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.legendHoverLink - */ - legendHoverLink?: boolean | undefined; - - /** - * Type of effect. - * Only ripple effect of `'ripple'` is supported currently. - * - * @default - * "ripple" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.effectType - */ - effectType?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.showEffectOn - */ - showEffectOn?: string | undefined; - - /** - * Related configurations about ripple effect. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.rippleEffect - */ - rippleEffect?: { - /** - * The period duration of animation, in seconds. - * - * @default - * 4 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.rippleEffect.period - */ - period?: number | undefined; - - /** - * The maximum zooming scale of ripples in animation. - * - * @default - * 2.5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.rippleEffect.scale - */ - scale?: number | undefined; - - /** - * The brush type for ripples. - * options: `'stroke'` and `'fill'`. - * - * @default - * "fill" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.rippleEffect.brushType - */ - brushType?: string | undefined; - } | undefined; - - /** - * The coordinate used in the series, whose options are: - * - * + `'cartesian2d'` - * - * Use a two-dimensional rectangular coordinate (also known as Cartesian - * coordinate), with - * [xAxisIndex](https://echarts.apache.org/en/option.html#series-bar.xAxisIndex) - * and - * [yAxisIndex](https://echarts.apache.org/en/option.html#series-bar.yAxisIndex) - * to assign the corresponding axis component. - * - * + `'polar'` - * - * Use polar coordinates, with - * [polarIndex](https://echarts.apache.org/en/option.html#series-bar.polarIndex) - * to assign the corresponding polar coordinate component. - * - * + `'geo'` - * - * Use geographic coordinate, with - * [geoIndex](https://echarts.apache.org/en/option.html#series-bar.geoIndex) - * to assign the corresponding geographic coordinate components. - * - * @default - * "cartesian2d" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.coordinateSystem - */ - coordinateSystem?: string | undefined; - - /** - * Index of - * [x axis](https://echarts.apache.org/en/option.html#xAxis) - * to combine with, which is useful for multiple x axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.xAxisIndex - */ - xAxisIndex?: number | undefined; - - /** - * Index of - * [y axis](https://echarts.apache.org/en/option.html#yAxis) - * to combine with, which is useful for multiple y axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.yAxisIndex - */ - yAxisIndex?: number | undefined; - - /** - * Index of - * [polar coordinate](https://echarts.apache.org/en/option.html#polar) - * to combine with, which is useful for multiple polar axes in one - * chart. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.polarIndex - */ - polarIndex?: number | undefined; - - /** - * Index of - * [geographic coordinate](https://echarts.apache.org/en/option.html#geo) - * to combine with, which is useful for multiple geographic axes - * in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.geoIndex - */ - geoIndex?: number | undefined; - - /** - * Index of - * [calendar coordinates](https://echarts.apache.org/en/option.html#calendar) - * to combine with, which is useful for multiple calendar coordinates - * in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.calendarIndex - */ - calendarIndex?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * @default - * "circle" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * The mouse style when mouse hovers on an element, the same as - * `cursor` property in `CSS`. - * - * @default - * "pointer" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.cursor - */ - cursor?: string | undefined; - - /** - * Text label of , to explain some data information about graphic - * item like value, name and so on. - * `label` is placed under `itemStyle` in ECharts 2.x. - * In ECharts 3, to make the configuration structure flatter, `label`is - * taken to be at the same level with `itemStyle`, and has `emphasis` - * as `itemStyle` does. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to represent - * position of label relative to top-left corner of bounding - * box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally and - * move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template and - * callback function. - * In either form, `\n` is supported to represent a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for example,`{@product}`refers - * the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, for - * example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * Graphic style of , `emphasis` is the style when it is highlighted, - * like being hovered by mouse, or highlighted via legend connect. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.itemStyle - */ - itemStyle?: { - /** - * color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides single - * colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.itemStyle.color - */ - color?: EChartOption.Color | Function | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle - */ - itemStyle?: { - /** - * color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides - * single colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle.color - */ - color?: EChartOption.Color | Function | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * When - * [dataset](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=dataset-series-layout-by) - * . - * - * @default - * "column" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.seriesLayoutBy - */ - seriesLayoutBy?: string | undefined; - - /** - * If - * [series.data](https://echarts.apache.org/en/option.html#series.data) - * is not specified, and - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * exists, the series will use `dataset`. - * `datasetIndex` specifies which dataset will be used. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.datasetIndex - */ - datasetIndex?: number | undefined; - - /** - * `dimensions` can be used to define dimension info for `series.data` - * or `dataset.source`. - * - * Notice: if - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * is used, we can provide dimension names in the first column/row - * of - * [dataset.source](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * [see doc](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.dimensions - */ - dimensions?: any[] | undefined; - - /** - * Define what is encoded to for each dimension of `data`. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * Attributes of encode are different according to the type of coordinate - * systtems. For - * [cartesian2d](https://echarts.apache.org/en/option.html#grid) - * , `x` and `y` can be defined. For - * [polar](https://echarts.apache.org/en/option.html#polar) - * , `radius` and `angle` can be defined. For - * [geo](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#dataZoom) - * on the axis will not filter the series. - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.encode - */ - encode?: object | undefined; - - /** - * Data array of series, which can be in the following forms: - * - * Notice, if no `data` specified in series, and there is - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * in option, series will use the first - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * as its datasource. If `data` has been specified, - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * will not used. - * - * `series.datasetIndex` can be used to specify other - * [dataset](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * + In - * [cartesian (grid)](https://echarts.apache.org/en/option.html#grid) - * , "dimX" and "dimY" correspond to - * [xAxis](https://echarts.apache.org/en/option.html#xAxis) - * and - * [yAxis](https://echarts.apache.org/en/option.html#yAxis) - * repectively. - * + In - * [polar](https://echarts.apache.org/en/option.html#polar) - * "dimX" and "dimY" correspond to - * [radiusAxis](https://echarts.apache.org/en/option.html#radiusAxis) - * 和 - * [angleAxis](https://echarts.apache.org/en/option.html#anbleAxis) - * repectively. - * + Other dimensions are optional, which can be used in other place. - * For example: - * + [visualMap](https://echarts.apache.org/en/option.html#visualMap) - * can map one or more dimensions to viusal (color, symbol size - * ...). - * + [series.symbolSize](https://echarts.apache.org/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://echarts.apache.org/en/option.html#tooltip.formatter) - * or - * [series.label.formatter](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * **Relationship between "value" and - * [axis.type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * There is an example of double category axes: - * [Github Punchcard](https://echarts.apache.org/examples/en/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.data - */ - data?: - | Array - | Array> - | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.x) - * , - * [y](https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.y) - * attribute, in which pixel values and percentage are supported. - * - * 2. Assign coordinate position with - * [coord](https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data - */ - data?: { - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.name - */ - name?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.type - */ - type?: string | undefined; - - /** - * Available when using - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.coord - */ - coord?: any[] | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectSactter.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.type) - * , where - * [valueIndex](https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=scatter-weight) - * - * The priority follows as above if more than one above definition - * used. - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * `zlevel` value of all graghical elements in . - * - * `zlevel` is used to make layers with Canvas. - * Graphical elements with different `zlevel` values will be placed - * in different Canvases, which is a common optimization technique. - * We can put those frequently changed elements (like those with - * animations) to a seperate `zlevel`. - * Notice that too many Canvases will increase memory cost, and - * should be used carefully on mobile phones to avoid crash. - * - * Canvases with bigger `zlevel` will be placed on Canvases with - * smaller `zlevel`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.zlevel - */ - zlevel?: number | undefined; - - /** - * `z` value of all graghical elements in , which controls order - * of drawing graphical components. - * Components with smaller `z` values may be overwritten by those - * with larger `z` values. - * - * `z` has a lower priority to `zlevel`, and will not create new - * Canvas. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.z - */ - z?: number | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger than - * threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback function - * for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesEffectScatter { - interface DataObject { - /** - * Symbol of single data. - * - * Icon types provided by ECharts includes `'circle'`, `'rect'`, - * `'roundRect'`, `'triangle'`, `'diamond'`, `'pin'`, `'arrow'`, - * `'none'` - * - * It can be set to an image with `'image://url'` , in which - * URL is the link to an image, or `dataURI` of an image. - * - * An image URL example: - * - * ``` - * 'image://http://xxx.xxx.xxx/a/b.png' - * - * ``` - * - * A `dataURI` example: - * - * [see doc](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data) - * - * @default - * "circle" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-effectScatter.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-effectScatter.effectScatter.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * tooltip settings in this series data. - * - * @see https://echarts.apache.org/en/option.html#series-effectScatter.data.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - } - } -} diff --git a/types/echarts/options/series/funnel.d.ts b/types/echarts/options/series/funnel.d.ts deleted file mode 100644 index cc995612d98ebb5..000000000000000 --- a/types/echarts/options/series/funnel.d.ts +++ /dev/null @@ -1,14466 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * **Funnel chart** - * - * **sample:** - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel) - * - * @see https://echarts.apache.org/en/option.html#series-funnel - */ - interface SeriesFunnel { - /** - * @default - * "funnel" - * @see https://echarts.apache.org/en/option.html#series-funnel.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.name - */ - name?: string | undefined; - - /** - * The specified minimum value. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.min - */ - min?: number | undefined; - - /** - * The specified maximum value. - * - * @default - * 100 - * @see https://echarts.apache.org/en/option.html#series-funnel.max - */ - max?: number | undefined; - - /** - * The mapped width from minimum data value - * [min](https://echarts.apache.org/en/option.html#series-funnel.min) - * . - * - * It can be absolute pixel and also the percentage of - * [layout width](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.minSize - */ - minSize?: string | undefined; - - /** - * The mapped width from maximum data value - * [max](https://echarts.apache.org/en/option.html#series-funnel.max) - * . - * - * It can be absolute pixel and also the percentage of - * [layout width](https://echarts.apache.org/en/option.html#series-funnel.width) - * . - * - * @default - * '100%' - * @see https://echarts.apache.org/en/option.html#series-funnel.maxSize - */ - maxSize?: string | undefined; - - /** - * Orient of funnel，Can be 'vertical' or 'horizontal'. - * - * @default - * "vertical" - * @see https://echarts.apache.org/v4/en/option.html#series-funnel.orient - */ - origin?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.sort - */ - sort?: string | undefined; - - /** - * Gap between each trapezoid. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.gap - */ - gap?: number | undefined; - - /** - * Whether to enable highlighting chart when - * [legend](https://echarts.apache.org/en/option.html#legend) - * is being hovered. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.legendHoverLink - */ - legendHoverLink?: boolean | undefined; - - /** - * Horizontal align. - * Defaults to align center. Can be 'left', 'right', 'center'. - * - * @default - * "center" - * @see https://echarts.apache.org/en/option.html#series-funnel.funnelAlign - */ - funnelAlign?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.label - */ - label?: { - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Options:** - * - * + `'left'` - * - * Left side of funnel chart. - * The corresponding trapezoid would be related to through - * [visual guide line](https://echarts.apache.org/en/option.html#series-funnel.labelLine) - * . - * - * + `'right'` - * - * Right side of funnel chart. - * The corresponding trapezoid would be related to through - * [visual guide line](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template and - * callback function. - * In either form, `\n` is supported to represent a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for example,`{@product}`refers - * the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, for - * example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * The visual guide line style of label. When - * [label position](https://echarts.apache.org/en/option.html#series-funnel.label.position) - * is set as `'left'`or`'right'`, the visual guide line will show. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine - */ - labelLine?: { - /** - * Whether to show visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.show - */ - show?: boolean | undefined; - - /** - * The length of the first part from visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.length - */ - length?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.labelLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.labelLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * The style of visual guide line in emphasis status. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis - */ - emphasis?: { - /** - * Whether to show visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis.show - */ - show?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.labelLine.emphasis.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.labelLine.emphasis.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.labelLine.emphasis.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Graphic style of , `emphasis` is the style when it is highlighted, - * like being hovered by mouse, or highlighted via legend connect. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.itemStyle - */ - itemStyle?: { - /** - * color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides single - * colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.itemStyle.color - */ - color?: EChartOption.Color | Function | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label - */ - label?: { - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine - */ - labelLine?: { - /** - * Whether to show visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.show - */ - show?: boolean | undefined; - - /** - * The length of the first part from visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.length - */ - length?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.labelLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.labelLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * The style of visual guide line in emphasis status. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis - */ - emphasis?: { - /** - * Whether to show visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis.show - */ - show?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.labelLine.emphasis.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.emphasis.labelLine.emphasis.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * `zlevel` value of all graphical 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 separate `zlevel`. - * Notice that too many Canvases will increase memory cost, and should be used carefully on mobile phones to avoid crash. - * - * Canvases with bigger `zlevel` will be placed on Canvases with smaller `zlevel`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.zlevel - */ - zlevel?: number | undefined; - - /** - * `z` value of all graphical 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. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.z - */ - z?: number | undefined; - - /** - * Distance between funnel chart component and the left side of the container. - * - * `left` value can be instant pixel value like `20`; - * it can also be a 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 - * '80' - * @see https://echarts.apache.org/en/option.html#series-funnel.left - */ - left?: string | number | undefined; - - /** - * Distance between funnel chart component and the top side of the container. - * - * `top` value can be instant pixel value like `20`; - * it can also be a 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 - * '60' - * @see https://echarts.apache.org/en/option.html#series-funnel.top - */ - top?: string | number | undefined; - - /** - * Distance between funnel chart component and the right side of the container. - * - * `right` value can be instant pixel value like `20`; - * it can also be a percentage value relative to container width like `'20%'`. - * - * @default - * '80' - * @see https://echarts.apache.org/en/option.html#series-funnel.right - */ - right?: string | number | undefined; - - /** - * Distance between funnel chart component and the bottom side of the container. - * `bottom` value can be instant pixel value like `20`; - * it can also be a percentage value relative to container width like `'20%'`. - * - * @default - * '60' - * @see https://echarts.apache.org/v4/en/option.html#series-funnel.bottom - */ - bottom?: string | number | undefined; - - /** - * Width of funnel chart component. Adaptive by default. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-funnel.width - */ - width?: string | number | undefined; - - /** - * Height of funnel chart component. Adaptive by default. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-funnel.height - */ - height?: string | number | undefined; - - /** - * When - * [dataset](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=dataset-series-layout-by) - * . - * - * @default - * "column" - * @see https://echarts.apache.org/en/option.html#series-funnel.seriesLayoutBy - */ - seriesLayoutBy?: string | undefined; - - /** - * If - * [series.data](https://echarts.apache.org/en/option.html#series.data) - * is not specified, and - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * exists, the series will use `dataset`. - * `datasetIndex` specifies which dataset will be used. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.datasetIndex - */ - datasetIndex?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel) - * - * Each data item can be further custerized: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data - */ - data?: number[] | number[][] | SeriesFunnel.DataObject[] | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data - */ - data?: { - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0 - */ - 0?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1 - */ - 1?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0 - */ - 0?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1 - */ - 1?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-funnel.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger than - * threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-funnel.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-funnel.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-funnel.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-funnel.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-funnel.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback function - * for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesFunnel { - interface DataObject { - /** - * the name of data item. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.name - */ - name?: string | undefined; - - /** - * data value. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.value - */ - value?: number | undefined; - - /** - * Graphic style of , `emphasis` is the style when it is highlighted, - * like being hovered by mouse, or highlighted via legend connect. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * The label configuration of a single data item. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label - */ - label?: { - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Options:** - * - * + `'left'` - * - * Left side of funnel chart. - * The corresponding trapezoid would be related to through - * [visual guide line](https://echarts.apache.org/en/option.html#series-funnel.labelLine) - * . - * - * + `'right'` - * - * Right side of funnel chart. - * The corresponding trapezoid would be related to through - * [visual guide line](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.data.label.position - */ - position?: string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine - */ - labelLine?: { - /** - * Whether to show visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.show - */ - show?: boolean | undefined; - - /** - * The length of the first part from visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.length - */ - length?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.data.labelLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.labelLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * The style of visual guide line in emphasis status. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis - */ - emphasis?: { - /** - * Whether to show visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis.show - */ - show?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.data.labelLine.emphasis.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.labelLine.emphasis.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label - */ - label?: { - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine - */ - labelLine?: { - /** - * Whether to show visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.show - */ - show?: boolean | undefined; - - /** - * The length of the first part from visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.length - */ - length?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.labelLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.labelLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * The style of visual guide line in emphasis status. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis - */ - emphasis?: { - /** - * Whether to show visual guide line. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.show - */ - show?: boolean | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.labelLine.emphasis.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-funnel.funnel.data.emphasis.labelLine.emphasis.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * tooltip settings in this series data. - * - * @see https://echarts.apache.org/en/option.html#series-funnel.data.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - } - } -} diff --git a/types/echarts/options/series/gauge.d.ts b/types/echarts/options/series/gauge.d.ts deleted file mode 100644 index d8e0da83db7989b..000000000000000 --- a/types/echarts/options/series/gauge.d.ts +++ /dev/null @@ -1,12777 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * **Gauge chart** - * - * **Example:** - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge) - * - * @see https://echarts.apache.org/en/option.html#series-gauge - */ - interface SeriesGauge { - /** - * @default - * "gauge" - * @see https://echarts.apache.org/en/option.html#series-gauge.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.name - */ - name?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.radius - */ - radius?: number | string | undefined; - - /** - * The start angle of gauge chart. The direct right side of - * [circle center](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.startAngle - */ - startAngle?: number | undefined; - - /** - * The end angle of gauge chart. - * - * @default - * -45 - * @see https://echarts.apache.org/en/option.html#series-gauge.endAngle - */ - endAngle?: number | undefined; - - /** - * Whether the scale in gauge chart increases clockwise. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.clockwise - */ - clockwise?: boolean | undefined; - - /** - * Data array of series, which can be a single data value. - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.data) - * - * Or, if need extra dimensions for components like [visualMap](https://echarts.apache.org/en/option.html#visualMap) - * to map to graphic attributes like color, it can also be in the form of array. - * - * In this case, we can assigin the second value in each arrary item to [visualMap](https://echarts.apache.org/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 https://echarts.apache.org/en/option.html#series-gauge.data - */ - data?: - | Array - | Array> - | undefined; - - /** - * The minimum data value which map to - * [minAngle](https://echarts.apache.org/en/option.html#series-gauge.minAngle) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.min - */ - min?: number | undefined; - - /** - * The maximum data value which map to - * [maxAngle](https://echarts.apache.org/en/option.html#series-gauge.maxAngle) - * . - * - * @default - * 100 - * @see https://echarts.apache.org/en/option.html#series-gauge.max - */ - max?: number | undefined; - - /** - * The number of split segments of gauge chart scale. - * - * @default - * 10 - * @see https://echarts.apache.org/en/option.html#series-gauge.splitNumber - */ - splitNumber?: number | undefined; - - /** - * The related configuration about the axis line of gauge chart. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLine - */ - axisLine?: { - /** - * Whether to show the axis line of gauge chart. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLine.show - */ - show?: boolean | undefined; - - /** - * The style of the axis line of gauge chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.axisLine.lineStyle.color - */ - color?: any[] | undefined; - - /** - * The width of axis line. - * - * @default - * 30 - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLine.lineStyle.width - */ - width?: number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.axisLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLine.lineStyle.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLine.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * The style of split line. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine - */ - splitLine?: { - /** - * Whether to show the split line. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.show - */ - show?: boolean | undefined; - - /** - * The length of split line, can be a pecentage value relative - * to radius. - * - * @default - * 30 - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.length - */ - length?: number | string | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.splitLine.lineStyle) - * - * @default - * "#eee" - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.splitLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.splitLine.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * The tick line style. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick - */ - axisTick?: { - /** - * Whether to show the scale. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.show - */ - show?: boolean | undefined; - - /** - * The split scale number between split line. - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.splitNumber - */ - splitNumber?: number | undefined; - - /** - * The length of tick line, can be a pecentage value relative - * to radius. - * - * @default - * 8 - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.length - */ - length?: number | string | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.axisTick.lineStyle) - * - * @default - * "#eee" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.axisTick.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisTick.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Axis tick label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel - */ - axisLabel?: { - /** - * Whether to show the label. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.show - */ - show?: boolean | undefined; - - /** - * The distance between the label and tick line. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.distance - */ - distance?: number | undefined; - - /** - * The content formatter of scale label, which supports both - * string template and callback function. Example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.axisLabel) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.fontSize - */ - fontSize?: number | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.axisLabel) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.axisLabel) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.axisLabel) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * Gauge chart pointer. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.pointer - */ - pointer?: { - /** - * Whether to show the pointer. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.pointer.show - */ - show?: boolean | undefined; - - /** - * The length of pointer which could be absolute value and also - * the percentage relative to - * [radius](https://echarts.apache.org/en/option.html#series-gauge.radius) - * . - * - * @default - * '80%' - * @see https://echarts.apache.org/en/option.html#series-gauge.pointer.length - */ - length?: number | string | undefined; - - /** - * The width of pointer. - * - * @default - * 8 - * @see https://echarts.apache.org/en/option.html#series-gauge.pointer.width - */ - width?: number | undefined; - } | undefined; - - /** - * The style of gauge chart. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle - */ - itemStyle?: { - /** - * The color of pointer. Defaults to use - * [the color of section](https://echarts.apache.org/en/option.html#series-gauge.axisLine.lineStyle.color) - * where the numerical value belongs to. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle.color - */ - color?: string | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle.borderColor - */ - borderColor?: string | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * The title of gauge chart. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title - */ - title?: { - /** - * Whether to show the title. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.title.offsetCenter - */ - offsetCenter?: any[] | undefined; - - /** - * text color. - * - * @default - * '#333' - * @see https://echarts.apache.org/en/option.html#series-gauge.title.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 15 - * @see https://echarts.apache.org/en/option.html#series-gauge.title.fontSize - */ - fontSize?: number | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.title) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.title) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.title) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.title.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.title.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.title.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * The detail about gauge chart which is used to show data. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail - */ - detail?: { - /** - * Whether to show the details. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.show - */ - show?: boolean | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.height - */ - height?: number | string | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.detail) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border width of the text fragment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Formatter is used to format detail, which supports string template and callback function. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.formatter - */ - formatter?: string | Function | undefined; - - /** - * Border color of the text fragment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.borderColor - */ - borderColor?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.detail.offsetCenter - */ - offsetCenter?: any[] | undefined; - - /** - * text color. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 15 - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.fontSize - */ - fontSize?: number | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.detail) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.detail) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich - */ - rich?: { - /** - * The text color. Defaults to use - * [the color of section](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.detail.rich.color - */ - // color?: string; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.detail.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.detail.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.detail.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data - */ - data?: { - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0 - */ - 0?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1 - */ - 1?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0 - */ - 0?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1 - */ - 1?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-gauge.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger than - * threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-gauge.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-gauge.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-gauge.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-gauge.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-gauge.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback function - * for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-gauge.gauge) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesGauge { - interface DataObject { - /** - * The name of data item. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.data.name - */ - name?: string | undefined; - - /** - * The value of a single data item. - * - * @see https://echarts.apache.org/en/option.html#series-gauge.data.value - */ - value?: number | undefined; - } - } - } -} diff --git a/types/echarts/options/series/graph.d.ts b/types/echarts/options/series/graph.d.ts deleted file mode 100644 index e329d556151f213..000000000000000 --- a/types/echarts/options/series/graph.d.ts +++ /dev/null @@ -1,19570 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * **relation graph** - * - * Graph is a diagram to represent - * [nodes](https://echarts.apache.org/en/option.html#series-graph.nodes) - * and the - * [links](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.layout) - * configuration as `'force'`. - * - * **Example:** - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph) - * - * @see https://echarts.apache.org/en/option.html#series-graph - */ - interface SeriesGraph { - /** - * @default - * "graph" - * @see https://echarts.apache.org/en/option.html#series-graph.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-graph.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.name - */ - name?: string | undefined; - - /** - * Whether to enable highlighting chart when - * [legend](https://echarts.apache.org/en/option.html#legend) - * is being hovered. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.legendHoverLink - */ - legendHoverLink?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.xAxisIndex) - * and - * [yAxisIndex](https://echarts.apache.org/en/option.html#series-graph.yAxisIndex) - * to assign the corresponding axis component. - * - * + `'polar'` - * - * Use polar coordinates, with - * [polarIndex](https://echarts.apache.org/en/option.html#series-graph.polarIndex) - * to assign the corresponding polar coordinate component. - * - * + `'geo'` - * - * Use geographic coordinate, with - * [geoIndex](https://echarts.apache.org/en/option.html#series-graph.geoIndex) - * to assign the corresponding geographic coordinate components. - * - * + `'none'` - * - * Do not use coordinate system. - * - * @see https://echarts.apache.org/en/option.html#series-graph.coordinateSystem - */ - coordinateSystem?: string | undefined; - - /** - * Index of - * [x axis](https://echarts.apache.org/en/option.html#xAxis) - * to combine with, which is useful for multiple x axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-graph.xAxisIndex - */ - xAxisIndex?: number | undefined; - - /** - * Index of - * [y axis](https://echarts.apache.org/en/option.html#yAxis) - * to combine with, which is useful for multiple y axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-graph.yAxisIndex - */ - yAxisIndex?: number | undefined; - - /** - * Index of - * [polar coordinate](https://echarts.apache.org/en/option.html#polar) - * to combine with, which is useful for multiple polar axes in one - * chart. - * - * @see https://echarts.apache.org/en/option.html#series-graph.polarIndex - */ - polarIndex?: number | undefined; - - /** - * Index of - * [geographic coordinate](https://echarts.apache.org/en/option.html#geo) - * to combine with, which is useful for multiple geographic axes - * in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-graph.geoIndex - */ - geoIndex?: number | undefined; - - /** - * Index of - * [calendar coordinates](https://echarts.apache.org/en/option.html#calendar) - * to combine with, which is useful for multiple calendar coordinates - * in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-graph.calendarIndex - */ - calendarIndex?: number | undefined; - - /** - * Whether to enable the highlight animation effect of mousr hover - * node. - * - * @see https://echarts.apache.org/en/option.html#series-graph.hoverAnimation - */ - hoverAnimation?: boolean | undefined; - - /** - * Graph layout. - * - * **Options:** - * - * + `'none'` No any layout, use - * [x](https://echarts.apache.org/en/option.html#series-graph.data.x) - * , - * [y](https://echarts.apache.org/en/option.html#series-graph.data.y) - * provided in - * [node](https://echarts.apache.org/en/option.html#series-graph.data) - * as the position of node. - * - * + `'circular'` Adopt circular layout, see the example - * [Les Miserables](https://echarts.apache.org/examples/en/editor.html?c=graph-circular-layout) - * . - * - * + `'force'` Adopt force-directed layout, see the example - * [Force](https://echarts.apache.org/examples/en/editor.html?c=graph-force) - * , the detail about configrations of layout are in - * [graph.force](https://echarts.apache.org/en/option.html#series-graph.force) - * - * @default - * "none" - * @see https://echarts.apache.org/en/option.html#series-graph.layout - */ - layout?: string | undefined; - - /** - * Configuration about circular layout. - * - * @see https://echarts.apache.org/en/option.html#series-graph.circular - */ - circular?: { - /** - * Whether to rotate the label automatically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.circular.rotateLabel - */ - rotateLabel?: boolean | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.data.x) - * , - * [y](https://echarts.apache.org/en/option.html#series-graph.data.y) - * provided in - * [node](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.force.initLayout - */ - initLayout?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.force.repulsion - */ - repulsion?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.force.gravity - */ - gravity?: number | undefined; - - /** - * The distance between 2 nodes on edge. - * This distance is also affected by - * [repulsion](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.force.edgeLength - */ - edgeLength?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.force.layoutAnimation - */ - layoutAnimation?: boolean | undefined; - - /** - * It will slow down the nodes' movement. The value range is from 0 to 1. - * But it is still an experimental option, see [#11024](https://github.com/apache/incubator-echarts/issues/11024). - * - * Since v4.5.0 - * - * @default - * 0.6 - * @see https://echarts.apache.org/en/option.html#series-graph.force.friction - */ - friction?: number | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.roam - */ - roam?: boolean | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.nodeScaleRatio - */ - nodeScaleRatio?: number | undefined; - - /** - * If node is draggable. - * Only available when using force-directed layout. - * - * @see https://echarts.apache.org/en/option.html#series-graph.draggable - */ - draggable?: boolean | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph) - * - * @default - * "circle" - * @see https://echarts.apache.org/en/option.html#series-graph.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters of - * data item. - * - * @default - * 10 - * @see https://echarts.apache.org/en/option.html#series-graph.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to focus/highlight the hover node and it's adjacencies. - * - * @see https://echarts.apache.org/en/option.html#series-graph.focusNodeAdjacency - */ - focusNodeAdjacency?: boolean | undefined; - - /** - * Symbol of two ends of edge line. - * - * For example: - * - * ``` - * edgeSymbol: ['circle', 'arrow'] - * - * ``` - * - * @default - * "[none', 'none']" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeSymbol - */ - edgeSymbol?: any[] | string | undefined; - - /** - * Size of symbol of two ends of edge line. - * Can be an array or a single number. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph) - * - * @default - * 10 - * @see https://echarts.apache.org/en/option.html#series-graph.edgeSymbolSize - */ - edgeSymbolSize?: any[] | number | undefined; - - /** - * The mouse style when mouse hovers on an element, the same as - * `cursor` property in `CSS`. - * - * @default - * "pointer" - * @see https://echarts.apache.org/en/option.html#series-graph.cursor - */ - cursor?: string | undefined; - - /** - * Graphic style of , `emphasis` is the style when it is highlighted, - * like being hovered by mouse, or highlighted via legend connect. - * - * @see https://echarts.apache.org/en/option.html#series-graph.itemStyle - */ - itemStyle?: { - /** - * color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides single - * colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.itemStyle.color - */ - color?: EChartOption.Color | Function | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * The style of edge line. - * [lineStyle.color](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.lineStyle) - * - * @default - * "#aaa" - * @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @default - * 0.5 - * @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.curveness - */ - curveness?: number | undefined; - } | undefined; - - /** - * Text label of , to explain some data information about graphic - * item like value, name and so on. - * `label` is placed under `itemStyle` in ECharts 2.x. - * In ECharts 3, to make the configuration structure flatter, `label`is - * taken to be at the same level with `itemStyle`, and has `emphasis` - * as `itemStyle` does. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to represent - * position of label relative to top-left corner of bounding - * box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-graph.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally and - * move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template and - * callback function. - * In either form, `\n` is supported to represent a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for example,`{@product}`refers - * the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, for - * example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel - */ - edgeLabel?: { - /** - * If show label on edge. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.show - */ - show?: boolean | undefined; - - /** - * Label position, options： - * - * + `'start'` - * + `'middle'` - * + `'end'` - * - * @default - * "middle" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template and - * callback function. - * In either form, `\n` is supported to represent a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for example,`{@product}`refers - * the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, for - * example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.edgeLabel) - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.edgeLabel) - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.edgeLabel) - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.edgeLabel) - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.edgeLabel) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.edgeLabel) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.emphasis.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel - */ - edgeLabel?: { - /** - * If show label on edge. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.show - */ - show?: boolean | undefined; - - /** - * Label position, options： - * - * + `'start'` - * + `'middle'` - * + `'end'` - * - * @default - * "middle" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.edgeLabel) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.edgeLabel) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.edgeLabel) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.edgeLabel) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.edgeLabel) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.edgeLabel) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#legend) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories - */ - categories?: SeriesGraph.CategoryObject[] | undefined; - - /** - * For the situation where there are multiple links between nodes, the curveness of each link is automatically calculated. - * When set to number, it indicates the length of the edge curvenness array between two nodes, and the calculation result is given by the internal algorithm. - * When set to Array, it means that the curveness array is directly specified, and the multilateral curveness is directly selected from the array. - * Notice： if lineStyle.curveness has been set, this property is invalid. - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.autoCurveness) - * - * @see https://echarts.apache.org/en/option.html#series-graph.autoCurveness - */ - autoCurveness?: number | number[] | undefined; - - /** - * Nodes list of graph. - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data - */ - data?: SeriesGraph.DataObject[] | undefined; - - /** - * Alias of - * [data](https://echarts.apache.org/en/option.html#series-graph.data) - * - * @see https://echarts.apache.org/en/option.html#series-graph.nodes - */ - nodes?: any[] | undefined; - - /** - * Relational data between nodes. Example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links - */ - links?: SeriesGraph.LinkObject[] | undefined; - - /** - * Alias of - * [links](https://echarts.apache.org/en/option.html#series-graph.links) - * - * @see https://echarts.apache.org/en/option.html#series-graph.edges - */ - edges?: any[] | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markPoint.data.x) - * , - * [y](https://echarts.apache.org/en/option.html#series-graph.markPoint.data.y) - * attribute, in which pixel values and percentage are supported. - * - * 2. Assign coordinate position with - * [coord](https://echarts.apache.org/en/option.html#series-graph.markPoint.data.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-graph.markPoint.data.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-graph.markPoint.data.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data - */ - data?: { - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.name - */ - name?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markPoint.data.type - */ - type?: string | undefined; - - /** - * Available when using - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markPoint.data.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markPoint.data.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.coord - */ - coord?: any[] | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-graph.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/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://echarts.apache.org/en/option.html#series-graph.graph.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markLine.data.1.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markLine.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markLine.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.type) - * , where - * [valueIndex](https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=scatter-weight) - * - * The priority follows as above if more than one above definition - * used. - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.1.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-graph.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * `zlevel` value of all graghical elements in . - * - * `zlevel` is used to make layers with Canvas. - * Graphical elements with different `zlevel` values will be placed - * in different Canvases, which is a common optimization technique. - * We can put those frequently changed elements (like those with - * animations) to a seperate `zlevel`. - * Notice that too many Canvases will increase memory cost, and - * should be used carefully on mobile phones to avoid crash. - * - * Canvases with bigger `zlevel` will be placed on Canvases with - * smaller `zlevel`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.zlevel - */ - zlevel?: number | undefined; - - /** - * `z` value of all graghical elements in , which controls order - * of drawing graphical components. - * Components with smaller `z` values may be overwritten by those - * with larger `z` values. - * - * `z` has a lower priority to `zlevel`, and will not create new - * Canvas. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-graph.z - */ - z?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.left - */ - left?: number | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.top - */ - top?: number | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.right - */ - right?: number | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.bottom - */ - bottom?: number | string | undefined; - - /** - * Width of component. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-graph.width - */ - width?: number | string | undefined; - - /** - * Height of component. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-graph.height - */ - height?: number | string | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to mouse - * events. - * - * @see https://echarts.apache.org/en/option.html#series-graph.silent - */ - silent?: boolean | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-graph.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger than - * threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-graph.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-graph.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-graph.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-graph.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-graph.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-graph.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback function - * for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-graph.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-graph.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesGraph { - interface CategoryObject { - /** - * Name of category, which is used to correspond with - * [legend](https://echarts.apache.org/en/option.html#legend) - * and the content of - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.name - */ - name?: string | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.categories) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.categories.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.categories.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.categories.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * The style of node in this category. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle - */ - itemStyle?: { - /** - * color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides - * single colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * The label style of node in this category. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.categories.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } - - interface DataObject { - /** - * Name of data item. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.name - */ - name?: string | undefined; - - /** - * `x` value of node position. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.x - */ - x?: number | undefined; - - /** - * `y` value of node position. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.y - */ - y?: number | undefined; - - /** - * If node are fixed when doing force directed layout. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.fixed - */ - fixed?: boolean | undefined; - - /** - * Value of data item. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.value - */ - value?: any[] | number | undefined; - - /** - * Index of category which the data item belongs to. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.category - */ - category?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.data) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-graph.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * The style of this node. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle - */ - itemStyle?: { - /** - * color. Color is taken from - * [option.color Palette](https://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides - * single colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * The label style of this node. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * tooltip settings in this series data. - * - * @see https://echarts.apache.org/en/option.html#series-graph.data.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - interface LinkObject { - /** - * [name of source node](https://echarts.apache.org/en/option.html#series-graph.data.name) - * on edge - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.source - */ - source?: string | undefined; - - /** - * [name of target node](https://echarts.apache.org/en/option.html#series-graph.data.name) - * on edge - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.target - */ - target?: string | undefined; - - /** - * value of edge, can be mapped to edge length in force graph. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.value - */ - value?: number | undefined; - - /** - * Line style of edges. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.links.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.links.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.links.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * The curveness of edge, supporting values from 0 to 1. - * The curveness will be larger as the value becomes lager. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.lineStyle.curveness - */ - curveness?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.links.label - */ - label?: { - /** - * If show label on edge. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.show - */ - show?: boolean | undefined; - - /** - * Label position, options： - * - * + `'start'` - * + `'middle'` - * + `'end'` - * - * @default - * "middle" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label - */ - label?: { - /** - * If show label on edge. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position, options： - * - * + `'start'` - * + `'middle'` - * + `'end'` - * - * @default - * "middle" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.links.emphasis.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.emphasis.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Symbol of edge ends. - * Can be an array with two item to specify two ends, or a string - * specifies both ends. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.symbol - */ - symbol?: any[] | string | undefined; - - /** - * Symbol size of edge ends. - * Can be an array with two item to specify two ends, or a string - * specifies both ends. - * - * @see https://echarts.apache.org/en/option.html#series-graph.links.symbolSize - */ - symbolSize?: any[] | string | undefined; - } - } - } -} diff --git a/types/echarts/options/series/heatmap.d.ts b/types/echarts/options/series/heatmap.d.ts deleted file mode 100644 index 6addda26fdd50b6..000000000000000 --- a/types/echarts/options/series/heatmap.d.ts +++ /dev/null @@ -1,13757 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * **heat map** - * - * Heat map mainly use colors to represent values, which must be used - * along with - * [visualMap](https://echarts.apache.org/en/option.html#visualMap) - * component. - * - * It can be used in either - * [rectangular coordinate](https://echarts.apache.org/en/option.html#grid) - * or - * [geographic coordinate](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap) - * - * **geographic coordinate:** - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap - */ - interface SeriesHeatmap { - /** - * @default - * "heatmap" - * @see https://echarts.apache.org/en/option.html#series-heatmap.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.name - */ - name?: string | undefined; - - /** - * The coordinate used in the series, whose options are: - * - * + `'cartesian2d'` - * - * Use a two-dimensional rectangular coordinate (also known as Cartesian - * coordinate), with - * [xAxisIndex](https://echarts.apache.org/en/option.html#series-heatmap.xAxisIndex) - * and - * [yAxisIndex](https://echarts.apache.org/en/option.html#series-heatmap.yAxisIndex) - * to assign the corresponding axis component. - * - * + `'geo'` - * - * Use geographic coordinate, with - * [geoIndex](https://echarts.apache.org/en/option.html#series-heatmap.geoIndex) - * to assign the corresponding geographic coordinate components. - * - * @default - * "cartesian2d" - * @see https://echarts.apache.org/en/option.html#series-heatmap.coordinateSystem - */ - coordinateSystem?: string | undefined; - - /** - * Index of - * [x axis](https://echarts.apache.org/en/option.html#xAxis) - * to combine with, which is useful for multiple x axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.xAxisIndex - */ - xAxisIndex?: number | undefined; - - /** - * Index of - * [y axis](https://echarts.apache.org/en/option.html#yAxis) - * to combine with, which is useful for multiple y axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.yAxisIndex - */ - yAxisIndex?: number | undefined; - - /** - * Index of - * [geographic coordinate](https://echarts.apache.org/en/option.html#geo) - * to combine with, which is useful for multiple geographic axes - * in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.geoIndex - */ - geoIndex?: number | undefined; - - /** - * Index of - * [calendar coordinates](https://echarts.apache.org/en/option.html#calendar) - * to combine with, which is useful for multiple calendar coordinates - * in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.calendarIndex - */ - calendarIndex?: number | undefined; - - /** - * Blur size of each data point. It is valid with - * [coordinateSystem](https://echarts.apache.org/en/option.html#series-heatmap.coordinateSystem) - * of 'geo' value. - * - * @default - * 20 - * @see https://echarts.apache.org/en/option.html#series-heatmap.blurSize - */ - blurSize?: number | undefined; - - /** - * Minimum opacity. It is valid with - * [coordinateSystem](https://echarts.apache.org/en/option.html#series-heatmap.coordinateSystem) - * of 'geo' value. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.minOpacity - */ - minOpacity?: number | undefined; - - /** - * Maximum opacity. It is valid with - * [coordinateSystem](https://echarts.apache.org/en/option.html#series-heatmap.coordinateSystem) - * of 'geo' value. - * - * @default - * 1 - * @see https://echarts.apache.org/en/option.html#series-heatmap.maxOpacity - */ - maxOpacity?: number | undefined; - - /** - * Work for - * [coordinateSystem](https://echarts.apache.org/en/option.html#series-heatmap.coordinateSystem) - * : 'cartesian2d'. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to represent - * position of label relative to top-left corner of bounding - * box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally and - * move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * Work for - * [coordinateSystem](https://echarts.apache.org/en/option.html#series-heatmap.coordinateSystem) - * : 'cartesian2d'. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data array of series, which can be in the following forms: - * - * Notice, if no `data` specified in series, and there is - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * in option, series will use the first - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * as its datasource. If `data` has been specified, - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * will not used. - * - * `series.datasetIndex` can be used to specify other - * [dataset](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap) - * - * + In - * [cartesian (grid)](https://echarts.apache.org/en/option.html#grid) - * , "dimX" and "dimY" correspond to - * [xAxis](https://echarts.apache.org/en/option.html#xAxis) - * and - * [yAxis](https://echarts.apache.org/en/option.html#yAxis) - * repectively. - * + In - * [polar](https://echarts.apache.org/en/option.html#polar) - * "dimX" and "dimY" correspond to - * [radiusAxis](https://echarts.apache.org/en/option.html#radiusAxis) - * 和 - * [angleAxis](https://echarts.apache.org/en/option.html#anbleAxis) - * repectively. - * + Other dimensions are optional, which can be used in other place. - * For example: - * + [visualMap](https://echarts.apache.org/en/option.html#visualMap) - * can map one or more dimensions to viusal (color, symbol size - * ...). - * + [series.symbolSize](https://echarts.apache.org/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://echarts.apache.org/en/option.html#tooltip.formatter) - * or - * [series.label.formatter](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap) - * - * **Relationship between "value" and - * [axis.type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap) - * - * There is an example of double category axes: - * [Github Punchcard](https://echarts.apache.org/examples/en/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.data - */ - data?: - | Array - | Array> - | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data - */ - data?: { - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0 - */ - 0?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1 - */ - 1?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0 - */ - 0?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1 - */ - 1?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-heatmap.zlevel - */ - zlevel?: number | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-heatmap.z - */ - z?: number | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to mouse - * events. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.silent - */ - silent?: boolean | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesHeatmap { - interface DataObject { - /** - * Name of data item. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.name - */ - name?: string | undefined; - - /** - * Value of data item. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.value - */ - value?: any[] | undefined; - - /** - * It is valid with - * [coordinateSystem](https://echarts.apache.org/en/option.html#series-heatmap.coordinateSystem) - * of 'cartesian2d' value. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * Style of a single data point. It is valid with - * [coordinateSystem](https://echarts.apache.org/en/option.html#series-heatmap.coordinateSystem) - * of 'cartesian2d' value. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-heatmap.heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } - } - } -} diff --git a/types/echarts/options/series/line.d.ts b/types/echarts/options/series/line.d.ts deleted file mode 100644 index 1943eef995351d8..000000000000000 --- a/types/echarts/options/series/line.d.ts +++ /dev/null @@ -1,14961 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * **broken line chart** - * - * Broken line chart relates all the data points - * [symbol](https://echarts.apache.org/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://echarts.apache.org/en/option.html#grid) - * and - * [polar coordinate](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Tip:** When - * [areaStyle](https://echarts.apache.org/en/option.html#series-line.areaStyle) - * is set, area chart will be drew. - * - * **Tip:** With - * [visualMap](https://echarts.apache.org/en/option.html#visualMap-piecewise) - * component, Broken line / area chart can have different colors on - * different sections, as below: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line) - * - * @see https://echarts.apache.org/en/option.html#series-line - */ - interface SeriesLine { - /** - * @default - * "line" - * @see https://echarts.apache.org/en/option.html#series-line.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-line.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-line.name - */ - name?: string | undefined; - - /** - * The coordinate used in the series, whose options are: - * - * + `'cartesian2d'` - * - * Use a two-dimensional rectangular coordinate (also known as Cartesian - * coordinate), with - * [xAxisIndex](https://echarts.apache.org/en/option.html#series-bar.xAxisIndex) - * and - * [yAxisIndex](https://echarts.apache.org/en/option.html#series-bar.yAxisIndex) - * to assign the corresponding axis component. - * - * + `'polar'` - * - * Use polar coordinates, with - * [polarIndex](https://echarts.apache.org/en/option.html#series-bar.polarIndex) - * to assign the corresponding polar coordinate component. - * - * @default - * "cartesian2d" - * @see https://echarts.apache.org/en/option.html#series-line.coordinateSystem - */ - coordinateSystem?: string | undefined; - - /** - * Index of - * [x axis](https://echarts.apache.org/en/option.html#xAxis) - * to combine with, which is useful for multiple x axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-line.xAxisIndex - */ - xAxisIndex?: number | undefined; - - /** - * Index of - * [y axis](https://echarts.apache.org/en/option.html#yAxis) - * to combine with, which is useful for multiple y axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-line.yAxisIndex - */ - yAxisIndex?: number | undefined; - - /** - * Index of - * [polar coordinate](https://echarts.apache.org/en/option.html#polar) - * to combine with, which is useful for multiple polar axes in one - * chart. - * - * @see https://echarts.apache.org/en/option.html#series-line.polarIndex - */ - polarIndex?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line) - * - * @default - * "circle" - * @see https://echarts.apache.org/en/option.html#series-line.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.data) - * , and the second parameter `params` is the rest parameters of - * data item. - * - * @default - * 4 - * @see https://echarts.apache.org/en/option.html#series-line.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-line.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to show symbol. - * It would be shown during tooltip hover. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.showSymbol - */ - showSymbol?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#xAxis.axisLabel.interval) - * . - * + `true`: Show all symbols. - * + `false`: Follow the interval strategy with - * [axisLabel.interval](https://echarts.apache.org/en/option.html#xAxis.axisLabel.interval) - * . - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-line.showAllSymbol - */ - showAllSymbol?: boolean | undefined; - - /** - * Whether to enable the animation effect when mouse is on the symbol. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.hoverAnimation - */ - hoverAnimation?: boolean | undefined; - - /** - * Whether to enable highlighting chart when - * [legend](https://echarts.apache.org/en/option.html#legend) - * is being hovered. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.legendHoverLink - */ - legendHoverLink?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#toolbox) - * on the top right corner: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line) - * - * @see https://echarts.apache.org/en/option.html#series-line.stack - */ - stack?: string | undefined; - - /** - * The mouse style when mouse hovers on an element, the same as - * `cursor` property in `CSS`. - * - * @default - * "pointer" - * @see https://echarts.apache.org/en/option.html#series-line.cursor - */ - cursor?: string | undefined; - - /** - * Whether to connect the line across null points. - * - * @see https://echarts.apache.org/en/option.html#series-line.connectNulls - */ - connectNulls?: boolean | undefined; - - /** - * Whether to clip the overflowing part, which defaults to clip. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.clipOverflow - */ - clipOverflow?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.line) - * - * @see https://echarts.apache.org/en/option.html#series-line.step - */ - step?: boolean | string | undefined; - - /** - * Text label of , to explain some data information about graphic - * item like value, name and so on. - * `label` is placed under `itemStyle` in ECharts 2.x. - * In ECharts 3, to make the configuration structure flatter, `label`is - * taken to be at the same level with `itemStyle`, and has `emphasis` - * as `itemStyle` does. - * - * @see https://echarts.apache.org/en/option.html#series-line.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to represent - * position of label relative to top-left corner of bounding - * box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "top" - * @see https://echarts.apache.org/en/option.html#series-line.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally and - * move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template and - * callback function. - * In either form, `\n` is supported to represent a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for example,`{@product}`refers - * the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, for - * example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual color, - * such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * The style of the symbol point of broken line. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#color) - * by default. - * - * > Color can be represented in RGB, for example `'rgb(128, - * 128, 128)'`. - * RGBA can be used when you need alpha channel, for example - * `'rgba(128, 128, 128, 0.5)'`. - * You may also use hexadecimal format, for example `'#ccc'`. - * Gradient color and texture are also supported besides single - * colors. - * > - * > [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.itemStyle.color - */ - color?: EChartOption.Color | Function | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * Line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-line.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * The style of area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.areaStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.areaStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.areaStyle.origin - */ - origin?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.areaStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.areaStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.areaStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.areaStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.areaStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.areaStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * 图形的高亮样式。 - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.smoothMonotone) - * to change smoothing algorithm. - * - * @see https://echarts.apache.org/en/option.html#series-line.smooth - */ - smooth?: boolean | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.line) - * - * The old algorithm has many problems: - * - * [see doc](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line) - * - * But new algorithm doesn't work with non-monotone data. - * - * [see doc](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.smoothMonotone - */ - smoothMonotone?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.sampling - */ - sampling?: string | undefined; - - /** - * `dimensions` can be used to define dimension info for `series.data` - * or `dataset.source`. - * - * Notice: if - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * is used, we can provide dimension names in the first column/row - * of - * [dataset.source](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line) - * [see doc](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.dimensions - */ - dimensions?: any[] | undefined; - - /** - * Define what is encoded to for each dimension of `data`. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line) - * - * Attributes of encode are different according to the type of coordinate - * systtems. For - * [cartesian2d](https://echarts.apache.org/en/option.html#grid) - * , `x` and `y` can be defined. For - * [polar](https://echarts.apache.org/en/option.html#polar) - * , `radius` and `angle` can be defined. For - * [geo](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#dataZoom) - * on the axis will not filter the series. - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line) - * - * @see https://echarts.apache.org/en/option.html#series-line.encode - */ - encode?: object | undefined; - - /** - * When - * [dataset](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=dataset-series-layout-by) - * . - * - * @default - * "column" - * @see https://echarts.apache.org/en/option.html#series-line.seriesLayoutBy - */ - seriesLayoutBy?: string | undefined; - - /** - * If - * [series.data](https://echarts.apache.org/en/option.html#series.data) - * is not specified, and - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * exists, the series will use `dataset`. - * `datasetIndex` specifies which dataset will be used. - * - * @see https://echarts.apache.org/en/option.html#series-line.datasetIndex - */ - datasetIndex?: number | undefined; - - /** - * Data array of series, which can be in the following forms: - * - * Notice, if no `data` specified in series, and there is - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * in option, series will use the first - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * as its datasource. If `data` has been specified, - * [dataset](https://echarts.apache.org/en/option.html#dataset) - * will not used. - * - * `series.datasetIndex` can be used to specify other - * [dataset](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line) - * - * + In - * [cartesian (grid)](https://echarts.apache.org/en/option.html#grid) - * , "dimX" and "dimY" correspond to - * [xAxis](https://echarts.apache.org/en/option.html#xAxis) - * and - * [yAxis](https://echarts.apache.org/en/option.html#yAxis) - * repectively. - * + In - * [polar](https://echarts.apache.org/en/option.html#polar) - * "dimX" and "dimY" correspond to - * [radiusAxis](https://echarts.apache.org/en/option.html#radiusAxis) - * 和 - * [angleAxis](https://echarts.apache.org/en/option.html#anbleAxis) - * repectively. - * + Other dimensions are optional, which can be used in other place. - * For example: - * + [visualMap](https://echarts.apache.org/en/option.html#visualMap) - * can map one or more dimensions to viusal (color, symbol size - * ...). - * + [series.symbolSize](https://echarts.apache.org/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://echarts.apache.org/en/option.html#tooltip.formatter) - * or - * [series.label.formatter](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line) - * - * **Relationship between "value" and - * [axis.type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line) - * - * There is an example of double category axes: - * [Github Punchcard](https://echarts.apache.org/examples/en/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.data - */ - data?: - | Array - | Array> - | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markPoint.data.x) - * , - * [y](https://echarts.apache.org/en/option.html#series-line.markPoint.data.y) - * attribute, in which pixel values and percentage are supported. - * - * 2. Assign coordinate position with - * [coord](https://echarts.apache.org/en/option.html#series-line.markPoint.data.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-line.markPoint.data.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-line.markPoint.data.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data - */ - data?: { - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.name - */ - name?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markPoint.data.type - */ - type?: string | undefined; - - /** - * Available when using - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markPoint.data.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markPoint.data.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.coord - */ - coord?: any[] | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-line.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-line.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markLine.data.0.coord) - * attribute, in which `'min'`, `'max'`, `'average'` are supported - * for each dimension. - * - * 3. Use - * [type](https://echarts.apache.org/en/option.html#series-line.markLine.data.0.type) - * attribute to mark the maximum and minimum values in the series, - * in which - * [valueIndex](https://echarts.apache.org/en/option.html#series-line.markLine.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/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://echarts.apache.org/en/option.html#series-line.line.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markLine.data.0.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markLine.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markLine.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markLine.data.1.type - */ - type?: string | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markLine.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Works only when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markLine.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#grid) - * , or `radius`, and `angle` for - * [polar coordinates](https://echarts.apache.org/en/option.html#polar) - * . - * - * **Notice:** For axis with - * [axis.type](https://echarts.apache.org/en/option.html#xAixs.type) - * `'category'`: - * - * + If coord value is `number`, it represents index - * of - * [axis.data](https://echarts.apache.org/en/option.html#xAxis.data) - * . - * + If coord value is `string`, it represents concrete - * value in - * [axis.data](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-line.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-line.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-line.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-line.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-line.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.0.type) - * , where - * [valueIndex](https://echarts.apache.org/en/option.html#series-line.markArea.data.0.valueIndex) - * or - * [valueDim](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=scatter-weight) - * - * The priority follows as above if more than one above definition - * used. - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.0.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.0.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.0.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.1.type - */ - type?: string | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.1.valueIndex - */ - valueIndex?: number | undefined; - - /** - * Specify the dimension on which min, max, average - * are calculated, available when - * [type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.1.valueDim - */ - valueDim?: string | undefined; - - /** - * The format is \[start coordinate, end coordinate\], - * where the coordinate system can be `x`, `y` on - * [cartesian](https://echarts.apache.org/en/option.html#grid) - * , or `radius`, `angle` on - * [polar](https://echarts.apache.org/en/option.html#polar) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.coord - */ - coord?: any[] | undefined; - - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-line.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-line.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-line.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-line.zlevel - */ - zlevel?: number | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-line.z - */ - z?: number | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to mouse - * events. - * - * @see https://echarts.apache.org/en/option.html#series-line.silent - */ - silent?: boolean | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-line.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger than - * threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-line.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-line.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "linear" - * @see https://echarts.apache.org/en/option.html#series-line.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-line.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-line.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-line.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback function - * for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-line.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - - /** - * tooltip settings in this series. - * - * @see https://echarts.apache.org/en/option.html#series-line.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - - namespace SeriesLine { - interface DataObject { - /** - * The name of data item. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.name - */ - name?: string | undefined; - - /** - * The value of a single data item. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.line.data) - * - * @default - * "circle" - * @see https://echarts.apache.org/en/option.html#series-line.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-line.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * The style of the text of single data point. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "top" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * The style of the symbol of single data point. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.itemStyle - */ - itemStyle?: { - /** - * Bar color.. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-line.data.itemStyle.color - */ - color?: string | undefined; - - /** - * The bodrder color of bar. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-line.data.itemStyle.barBorderColor - */ - barBorderColor?: string | undefined; - - /** - * The bodrder width of bar. defaults to have no border. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.itemStyle.barBorderWidth - */ - barBorderWidth?: number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.itemStyle.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.itemStyle - */ - itemStyle?: { - /** - * Bar color.. - * - * @default - * "auto" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.itemStyle.color - */ - color?: string | undefined; - - /** - * The bodrder color of bar. - * - * @default - * '#000' - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.itemStyle.barBorderColor - */ - barBorderColor?: string | undefined; - - /** - * The bodrder width of bar. - * defaults to have no border. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.itemStyle.barBorderWidth - */ - barBorderWidth?: number | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.emphasis.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.itemStyle.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.itemStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.emphasis.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.data.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-line.line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * tooltip settings in this series data. - * - * @see https://echarts.apache.org/en/option.html#series-line.data.tooltip - */ - tooltip?: BaseTooltip | undefined; - } - } - } -} diff --git a/types/echarts/options/series/lines.d.ts b/types/echarts/options/series/lines.d.ts deleted file mode 100644 index 780c3a315e73519..000000000000000 --- a/types/echarts/options/series/lines.d.ts +++ /dev/null @@ -1,13774 +0,0 @@ -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://echarts.apache.org/en/option.html#series-lines) - * - * @see https://echarts.apache.org/en/option.html#series-lines - */ - interface SeriesLines { - /** - * @default - * "lines" - * @see https://echarts.apache.org/en/option.html#series-lines.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-lines.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.name - */ - name?: string | undefined; - - /** - * The coordinate used in the series, whose options are: - * - * + `'cartesian2d'` - * - * Use a two-dimensional rectangular coordinate (also known as Cartesian - * coordinate), with - * [xAxisIndex](https://echarts.apache.org/en/option.html#series-lines.xAxisIndex) - * and - * [yAxisIndex](https://echarts.apache.org/en/option.html#series-lines.yAxisIndex) - * to assign the corresponding axis component. - * - * + `'geo'` - * - * Use geographic coordinate, with - * [geoIndex](https://echarts.apache.org/en/option.html#series-lines.geoIndex) - * to assign the corresponding geographic coordinate components. - * - * @default - * "geo" - * @see https://echarts.apache.org/en/option.html#series-lines.coordinateSystem - */ - coordinateSystem?: string | undefined; - - /** - * Index of - * [x axis](https://echarts.apache.org/en/option.html#xAxis) - * to combine with, which is useful for multiple x axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-lines.xAxisIndex - */ - xAxisIndex?: number | undefined; - - /** - * Index of - * [y axis](https://echarts.apache.org/en/option.html#yAxis) - * to combine with, which is useful for multiple y axes in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-lines.yAxisIndex - */ - yAxisIndex?: number | undefined; - - /** - * Index of - * [geographic coordinate](https://echarts.apache.org/en/option.html#geo) - * to combine with, which is useful for multiple geographic axes - * in one chart. - * - * @see https://echarts.apache.org/en/option.html#series-lines.geoIndex - */ - geoIndex?: number | undefined; - - /** - * If draw as polyline. - * - * Default to be `false`. Can only draw a two end straight line. - * - * If it is set true, - * [data.coords](https://echarts.apache.org/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://echarts.apache.org/examples/en/editor.html?c=lines-bmap-bus) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.polyline - */ - polyline?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.zlevel) - * need to be different with others. And the animation ( - * [animation](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.label) - * of animation would produce unnecessary ghosts. - * - * @see https://echarts.apache.org/en/option.html#series-lines.effect - */ - effect?: { - /** - * Whether to show special effect. - * - * @see https://echarts.apache.org/en/option.html#series-lines.effect.show - */ - show?: boolean | undefined; - - /** - * The duration of special effect, which unit is second. - * - * @default - * 4 - * @see https://echarts.apache.org/en/option.html#series-lines.effect.period - */ - period?: number | undefined; - - /** - * Effect animation delay. - * Can be number or callback function. - * - * @see https://echarts.apache.org/en/option.html#series-lines.effect.delay - */ - delay?: Function | number | undefined; - - /** - * If symbol movement of special effect has a constant speed, - * which unit is pixel per second. - * [period](https://echarts.apache.org/en/option.html#series-lines.effect.period) - * will be ignored if `constantSpeed` is larger than 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.effect.constantSpeed - */ - constantSpeed?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.effect.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.effect.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * The color of special effect symbol, which defaults to be - * same with - * [lineStyle.color](https://echarts.apache.org/en/option.html#series-lines.lineStyle.color) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.effect.color - */ - color?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.effect.trailLength - */ - trailLength?: number | undefined; - - /** - * Whether to loop the special effect animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.effect.loop - */ - loop?: boolean | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.large - */ - large?: boolean | undefined; - - /** - * The threshold enabling the drawing optimization. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-lines.largeThreshold - */ - largeThreshold?: number | undefined; - - /** - * Symbol type at the two ends of the line. - * It can be an array for two ends, or assigned seperately. See - * [data.symbol](https://echarts.apache.org/en/option.html#series-line.markLine.data.0.symbol) - * for more format information. - * - * @default - * "none" - * @see https://echarts.apache.org/en/option.html#series-lines.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.lineStyle - */ - lineStyle?: { - /** - * Line color. Color is taken from - * [option.color Palette](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.lineStyle) - * - * @default - * "self-adaptive" - * @see https://echarts.apache.org/en/option.html#series-lines.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not be - * drawn when set to 0. - * - * @default - * 0.5 - * @see https://echarts.apache.org/en/option.html#series-lines.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.lineStyle.curveness - */ - curveness?: number | undefined; - } | undefined; - - /** - * Label settings. Does not work when - * [polyline](https://echarts.apache.org/en/option.html#series-lines.polyline) - * is `true`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.show - */ - show?: boolean | undefined; - - /** - * the position of label, options: - * - * + `'start'` - * + `'middle'` - * + `'end'` - * - * @default - * "end" - * @see https://echarts.apache.org/en/option.html#series-lines.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template and - * callback function. - * In either form, `\n` is supported to represent a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for example,`{@product}`refers - * the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, for - * example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, right, - * bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple table - * or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because that each text fregment - * is layout based on the `content box`, where it makes no sense - * that calculating width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and height - * of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * Emphasis style. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.emphasis.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.lineStyle.opacity - */ - opacity?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * the position of label, options: - * - * + `'start'` - * + `'middle'` - * + `'end'` - * - * @default - * "end" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-lines.progressive - */ - progressive?: number | undefined; - - /** - * If current data amount is over the threshold, "progressive rendering" - * is enabled. - * - * @default - * 3000 - * @see https://echarts.apache.org/en/option.html#series-lines.progressiveThreshold - */ - progressiveThreshold?: number | undefined; - - /** - * The data set of lines. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data - */ - data?: SeriesLines.DataObject[] | undefined; - - /** - * Mark point in a chart. - * - * @see https://echarts.apache.org/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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markPoint) - * - * @default - * "pin" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-.data) - * , and the second parameter `params` is the rest parameters - * of data item. - * - * @default - * 50 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.symbolSize - */ - symbolSize?: any[] | Function | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markPoint.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markPoint.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to - * mouse events. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.silent - */ - silent?: boolean | undefined; - - /** - * Label of mark point. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @default - * "inside" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markPoint.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {@score}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markPoint.data.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markPoint) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data - */ - data?: { - /** - * Mark point name. - * - * @default - * '' - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markPoint.data.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markPoint.data.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markPoint.data.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Mark point style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markPoint) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * prefix - * - * @see https://echarts.apache.org/en/option.html#series-lines.markPoint.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Use a line in the chart to illustrate. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markLine.silent - */ - silent?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.0.symbol) - * for more format information. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.symbol - */ - symbol?: any[] | string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * Precison of marking line value, which is useful when displaying - * average value mark line. - * - * @default - * 2 - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.precision - */ - precision?: number | undefined; - - /** - * Mark line text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - - /** - * Mark line style. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markLine.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markLine.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markLine) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data - */ - data?: { - /** - * Data of the starting point. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0 - */ - 0?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.0) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.0.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.0.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.0.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.0.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.0.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.0.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.0.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.0.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.0.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.0.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Data of the ending point. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1 - */ - 1?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.name - */ - name?: string | undefined; - - /** - * X position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.x - */ - x?: number | undefined; - - /** - * Y position according to container, in pixel. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.y - */ - y?: number | undefined; - - /** - * Label value, which can be ignored. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.value - */ - value?: number | undefined; - - /** - * 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://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.1) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.symbol - */ - symbol?: string | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.1.symbolSize - */ - symbolSize?: any[] | number | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.1.symbolRotate - */ - symbolRotate?: number | undefined; - - /** - * Whether to keep aspect for symbols in the form of - * `path://`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.symbolKeepAspect - */ - symbolKeepAspect?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.1.symbolOffset - */ - symbolOffset?: any[] | undefined; - - /** - * Line style of this data item, which will be merged - * with `lineStyle` of starting point and ending point. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.1.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.1.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to - * 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.curveness - */ - curveness?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.1.lineStyle.emphasis) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.1.lineStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from - * 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.curveness - */ - curveness?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label of this data item, which will be merged with - * `label` of starting point and ending point. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.label - */ - label?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.label.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.1.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value - * at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by - * formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether show label or not. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markLine.data.1.label.emphasis.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string - * template and callback function. - * In either form, `\n` is supported to represent - * a new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value - * of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the - * index of`n`, for example,`{@\[3\]}\` refers - * the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed - * by formatter, which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.data.1.label.emphasis.formatter - */ - formatter?: Function | string | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markLine) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markLine.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * Used to mark an area in chart. - * For example, mark a time interval. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markArea.silent - */ - silent?: boolean | undefined; - - /** - * Label in mark area. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values to - * represent position of label relative to top-left corner - * of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value represents - * rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive value - * represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as visual - * color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - - /** - * Style of the mark area. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. - * `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that of - * `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * 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://echarts.apache.org/en/option.html#series-lines.markArea.data.0.x) - * , - * [y](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markArea) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data - */ - data?: { - /** - * Specify the left-top point. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0 - */ - 0?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Specify the right-bottom point. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1 - */ - 1?: { - /** - * Name of the marker, which will display as a label. - * - * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.name - */ - name?: string | undefined; - - /** - * x value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.x - */ - x?: number | undefined; - - /** - * y value on screen coordinate system, can be pixel - * number (like `5`), or percent value (like `'20%'`). - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.y - */ - y?: number | undefined; - - /** - * value of the item, not necessary. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.value - */ - value?: number | undefined; - - /** - * Style of the item. - * `itemStyle` of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to that - * of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.itemStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of - * shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.opacity - */ - opacity?: number | undefined; - - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.color - */ - color?: EChartOption.Color | undefined; - - /** - * border color, whose format is similar to - * that of `color`. - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.borderColor - */ - borderColor?: EChartOption.Color | undefined; - - /** - * border width. - * No border when it is set to be 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border type, which can be `'solid'`, `'dashed'`, - * or `'dotted'`. `'solid'` by default. - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.borderType - */ - borderType?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with - * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` - * to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.itemStyle.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. - * Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction - * of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component - * will not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.opacity - */ - opacity?: number | undefined; - } | undefined; - } | undefined; - - /** - * Label style of the item. - * Label style of start point and end point will be - * merged together. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel values - * to represent position of label relative to top-left - * corner of bounding box. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned as - * visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will be - * used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent - * of `contentWidth` (that is, the width - * without `padding`) of its container box. - * It is based on `contentWidth` because - * that each text fregment is layout based - * on the `content box`, where it makes - * no sense that calculating width based - * on `outerWith` in prectice. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only work - * when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis - */ - emphasis?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.show - */ - show?: boolean | undefined; - - /** - * Label position. - * - * **Followings are the options:** - * - * + \[x, y\] - * - * Use relative percentage, or absolute pixel - * values to represent position of label relative - * to top-left corner of bounding box. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) - * - * + 'top' - * - * + 'left' - * + 'right' - * + 'bottom' - * + 'inside' - * + 'insideLeft' - * + 'insideRight' - * + 'insideTop' - * + 'insideBottom' - * + 'insideTopLeft' - * + 'insideBottomLeft' - * + 'insideTopRight' - * + 'insideBottomRight' - * - * See: - * [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.position - */ - position?: any[] | string | undefined; - - /** - * Distance to the host graphic element. - * Works when position is string value (like - * `'top'`、`'insideRight'`). - * - * See: - * [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position) - * . - * - * @default - * 5 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.distance - */ - distance?: number | undefined; - - /** - * Rotate label, from -90 degree to 90, positive - * value represents rotate anti-clockwise. - * - * See: - * [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rotate - */ - rotate?: number | undefined; - - /** - * Whether to move text slightly. - * For example: `[30, 40]` means move `30` horizontally - * and move `40` vertically. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.offset - */ - offset?: any[] | undefined; - - /** - * text color. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will assigned - * as visual color, such as series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this - * `rich` property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', - * ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic - * by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, - * `align` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic - * by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in - * `rich`, `verticalAlign` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, - * `lineHeight` in parent level will - * be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, - * `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for - * example: - * - * + `padding: [3, 4, 5, 6]`: represents - * padding of `[top, right, bottom, - * left]`. - * + `padding: 4`: represents `padding: - * [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to - * specify it. - * You may want to use it in some cases - * like make simple table or using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * `width` can also be percent string, - * like `'100%'`, which represents the - * percent of `contentWidth` (that is, - * the width without `padding`) of its - * container box. - * It is based on `contentWidth` because - * that each text fregment is layout - * based on the `content box`, where - * it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases - * like using background image (see - * `backgroundColor`). - * - * Notice, `width` and `height` specifies - * the width and height of the content, - * without `padding`. - * - * Notice, `width` and `height` only - * work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * If set as `'auto'`, the color will - * assigned as visual color, such as - * series color. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - } | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger - * than threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback - * function for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports - * callback function for different data to have different animation - * effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.markArea) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-lines.markArea.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-lines.zlevel - */ - zlevel?: number | undefined; - - /** - * `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://echarts.apache.org/en/option.html#series-lines.z - */ - z?: number | undefined; - - /** - * Whether to ignore mouse events. - * Default value is false, for triggering and responding to mouse - * events. - * - * @see https://echarts.apache.org/en/option.html#series-lines.silent - */ - silent?: boolean | undefined; - - /** - * Whether to enable animation. - * - * @default - * "true" - * @see https://echarts.apache.org/en/option.html#series-lines.animation - */ - animation?: boolean | undefined; - - /** - * Whether to set graphic number threshold to animation. - * Animation will be disabled when graphic number is larger than - * threshold. - * - * @default - * 2000 - * @see https://echarts.apache.org/en/option.html#series-lines.animationThreshold - */ - animationThreshold?: number | undefined; - - /** - * Duration of the first animation, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines) - * - * @default - * 1000 - * @see https://echarts.apache.org/en/option.html#series-lines.animationDuration - */ - animationDuration?: Function | number | undefined; - - /** - * Easing method used for the first animation. - * Varied easing effects can be found at - * [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing) - * . - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-lines.animationEasing - */ - animationEasing?: string | undefined; - - /** - * Delay before updating the first animation, which supports callback - * function for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-lines.animationDelay - */ - animationDelay?: Function | number | undefined; - - /** - * Time for animation to complete, which supports callback function - * for different data to have different animation effect: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines) - * - * @default - * 300 - * @see https://echarts.apache.org/en/option.html#series-lines.animationDurationUpdate - */ - animationDurationUpdate?: Function | number | undefined; - - /** - * Easing method used for animation. - * - * @default - * "cubicOut" - * @see https://echarts.apache.org/en/option.html#series-lines.animationEasingUpdate - */ - animationEasingUpdate?: string | undefined; - - /** - * Delay before updating animation, which supports callback function - * for different data to have different animation effect. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines) - * - * See - * [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) - * for more information. - * - * @see https://echarts.apache.org/en/option.html#series-lines.animationDelayUpdate - */ - animationDelayUpdate?: Function | number | undefined; - } - - namespace SeriesLines { - interface DataObject { - /** - * the name of data. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.name - */ - name?: string | undefined; - - /** - * An array includes two ore more than two coordinates. - * Each coordinate could be `[x, y]` in - * [rectangular coordinate](https://echarts.apache.org/en/option.html#grid) - * and `[lng, lat]` in - * [geographic coordinate](https://echarts.apache.org/en/option.html#geo) - * . - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.coords - */ - coords?: any[] | undefined; - - /** - * The line style of this data item. - * - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.data.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.data.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.data.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will not - * be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.lineStyle.curveness - */ - curveness?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.data.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.show - */ - show?: boolean | undefined; - - /** - * the position of label, options: - * - * + `'start'` - * + `'middle'` - * + `'end'` - * - * @default - * "end" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a new - * line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, for - * example,`{@product}`refers the value of`'product'\` dimension。 - * + `{@[n]}: the value of a dimension at the index of`n`, - * for example,`{@\[3\]}\` refers the value at dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent level - * will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` in - * parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of `[top, - * right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, which - * represents the percent of `contentWidth` (that is, the - * width without `padding`) of its container box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on `outerWith` - * in prectice. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width and - * height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` property. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, - * 4]`. - * + `padding: [3, 4]`: represents `padding: [3, - * 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make - * simple table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` - * (that is, the width without `padding`) of its - * container box. - * It is based on `contentWidth` because that each - * text fregment is layout based on the `content - * box`, where it makes no sense that calculating - * width based on `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using - * background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis - */ - emphasis?: { - /** - * @see https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.lineStyle) - * - * @default - * "#000" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.lineStyle.color - */ - color?: EChartOption.Color | undefined; - - /** - * line width. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.lineStyle.width - */ - width?: number | undefined; - - /** - * line type. - * - * Options are: - * - * + `'solid'` - * + `'dashed'` - * + `'dotted'` - * - * @default - * "solid" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.lineStyle.type - */ - type?: string | undefined; - - /** - * Size of shadow blur. - * This attribute should be used along with `shadowColor`,`shadowOffsetX`, - * `shadowOffsetY` to set shadow to component. - * - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.lineStyle) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.lineStyle.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow color. Support same format as `color`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.lineStyle.shadowColor - */ - shadowColor?: EChartOption.Color | undefined; - - /** - * Offset distance on the horizontal direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.lineStyle.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Offset distance on the vertical direction of shadow. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.lineStyle.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Opacity of the component. - * Supports value from 0 to 1, and the component will - * not be drawn when set to 0. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.lineStyle.opacity - */ - opacity?: number | undefined; - - /** - * Edge curvature, which supports value from 0 to 1. - * The larger the value, the greater the curvature. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.lineStyle.curveness - */ - curveness?: number | undefined; - } | undefined; - - /** - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label - */ - label?: { - /** - * Whether to show label. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.show - */ - show?: boolean | undefined; - - /** - * the position of label, options: - * - * + `'start'` - * + `'middle'` - * + `'end'` - * - * @default - * "end" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.position - */ - position?: string | undefined; - - /** - * Data label formatter, which supports string template - * and callback function. - * In either form, `\n` is supported to represent a - * new line. - * - * **String template** - * - * Model variation includes: - * - * + `{a}`: series name. - * + `{b}`: the name of a data item. - * + `{c}`: the value of a data item. - * + `{d}`: the percent. - * + `{@xxx}: the value of a dimension named`'xxx'`, - * for example,`{@product}`refers the value of`'product'\` - * dimension。 - * + `{@[n]}: the value of a dimension at the index - * of`n`, for example,`{@\[3\]}\` refers the value at - * dimensions\[3\]. - * - * **example:** - * - * ``` - * formatter: '{b}: {d}' - * - * ``` - * - * **Callback function** - * - * Callback function is in form of: - * - * ``` - * (params: Object|Array) => string - * - * ``` - * - * where `params` is the single dataset needed by formatter, - * which is formed as: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.formatter - */ - formatter?: Function | string | undefined; - - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` in parent - * level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, `verticalAlign` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.label) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.label) - * - * `width` or `height` can be specified when using background - * image, or auto adapted by default. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding of - * `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: [3, 4, - * 3, 4]`. - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify it. - * You may want to use it in some cases like make simple - * table or using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * `width` can also be percent string, like `'100%'`, - * which represents the percent of `contentWidth` (that - * is, the width without `padding`) of its container - * box. - * It is based on `contentWidth` because that each text - * fregment is layout based on the `content box`, where - * it makes no sense that calculating width based on - * `outerWith` in prectice. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like using background - * image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the width - * and height of the content, without `padding`. - * - * Notice, `width` and `height` only work when `rich` - * specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - - /** - * "Rich text styles" can be defined in this `rich` - * property. For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.label) - * - * For more details, see - * [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text) - * please. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich - */ - rich?: { - /** - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E - */ - [userStyle: string]: { - /** - * text color. - * - * @default - * ""#fff"" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color - */ - color?: string | undefined; - - /** - * font style - * - * Options are: - * - * + `'normal'` - * + `'italic'` - * + `'oblique'` - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle - */ - fontStyle?: string | undefined; - - /** - * font thick weight - * - * Options are: - * - * + `'normal'` - * + `'bold'` - * + `'bolder'` - * + `'lighter'` - * + 100 | 200 | 300 | 400... - * - * @default - * "normal" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight - */ - fontWeight?: string | number | undefined; - - /** - * font family - * - * Can also be 'serif' , 'monospace', ... - * - * @default - * "sans-serif" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily - */ - fontFamily?: string | undefined; - - /** - * font size - * - * @default - * 12 - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize - */ - fontSize?: number | undefined; - - /** - * Horizontal alignment of text, automatic by - * default. - * - * Options are: - * - * + `'left'` - * + `'center'` - * + `'right'` - * - * If `align` is not set in `rich`, `align` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align - */ - align?: string | undefined; - - /** - * Vertical alignment of text, automatic by - * default. - * - * Options are: - * - * + `'top'` - * + `'middle'` - * + `'bottom'` - * - * If `verticalAlign` is not set in `rich`, - * `verticalAlign` in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign - */ - verticalAlign?: string | undefined; - - /** - * Line height of the text fregment. - * - * If `lineHeight` is not set in `rich`, `lineHeight` - * in parent level will be used. - * For example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-lines.lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight - */ - lineHeight?: number | undefined; - - /** - * Background color of the text fregment. - * - * Can be color string, like `'#123234'`, `'red'`, - * `rgba(0,23,11,0.3)'`. - * - * Or image can be used, for example: - * - * [see doc](https://echarts.apache.org/en/option.html#series-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://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor - */ - backgroundColor?: object | string | undefined; - - /** - * Border color of the text fregment. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor - */ - borderColor?: string | undefined; - - /** - * Border width of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth - */ - borderWidth?: number | undefined; - - /** - * Border radius of the text fregment. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius - */ - borderRadius?: number | undefined; - - /** - * Padding of the text fregment, for example: - * - * + `padding: [3, 4, 5, 6]`: represents padding - * of `[top, right, bottom, left]`. - * + `padding: 4`: represents `padding: [4, - * 4, 4, 4]`. - * + `padding: [3, 4]`: represents `padding: - * [3, 4, 3, 4]`. - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding - */ - padding?: any[] | number | undefined; - - /** - * Shadow color of the text block. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor - */ - shadowColor?: string | undefined; - - /** - * Show blur of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur - */ - shadowBlur?: number | undefined; - - /** - * Shadow X offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX - */ - shadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text block. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY - */ - shadowOffsetY?: number | undefined; - - /** - * Width of the text block. - * It is the width of the text by default. - * In most cases, there is no need to specify - * it. - * You may want to use it in some cases like - * make simple table or using background image - * (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * `width` can also be percent string, like - * `'100%'`, which represents the percent of - * `contentWidth` (that is, the width without - * `padding`) of its container box. - * It is based on `contentWidth` because that - * each text fregment is layout based on the - * `content box`, where it makes no sense that - * calculating width based on `outerWith` in - * prectice. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width - */ - width?: number | string | undefined; - - /** - * Height of the text block. - * It is the width of the text by default. - * You may want to use it in some cases like - * using background image (see `backgroundColor`). - * - * Notice, `width` and `height` specifies the - * width and height of the content, without - * `padding`. - * - * Notice, `width` and `height` only work when - * `rich` specified. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height - */ - height?: number | string | undefined; - - /** - * Storke color of the text. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor - */ - textBorderColor?: string | undefined; - - /** - * Storke line width of the text. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth - */ - textBorderWidth?: number | undefined; - - /** - * Shadow color of the text itself. - * - * @default - * "transparent" - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor - */ - textShadowColor?: string | undefined; - - /** - * Shadow blue of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur - */ - textShadowBlur?: number | undefined; - - /** - * Shadow X offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX - */ - textShadowOffsetX?: number | undefined; - - /** - * Shadow Y offset of the text itself. - * - * @see https://echarts.apache.org/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY - */ - textShadowOffsetY?: number | undefined; - }; - } | undefined; - } | undefined; - } | undefined; - } - } - } -} diff --git a/types/echarts/options/series/map.d.ts b/types/echarts/options/series/map.d.ts deleted file mode 100644 index 1c50c267ee85264..000000000000000 --- a/types/echarts/options/series/map.d.ts +++ /dev/null @@ -1,14311 +0,0 @@ -declare namespace echarts { - namespace EChartOption { - /** - * **Map.** - * - * Map is maily used in the visulization of geographic area data, which - * can be used with - * [visualMap](https://echarts.apache.org/en/option.html#visualMap) - * component to visualize the datas such as population distribution - * density in diffrent areas. - * - * Series of same - * [map type](https://echarts.apache.org/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://echarts.apache.org/en/option.html#series-map) - * - * @see https://echarts.apache.org/en/option.html#series-map - */ - interface SeriesMap { - /** - * @default - * "map" - * @see https://echarts.apache.org/en/option.html#series-map.type - */ - type?: string | undefined; - - /** - * Component ID, not specified by default. - * If specified, it can be used to refer the component in option - * or API. - * - * @see https://echarts.apache.org/en/option.html#series-map.id - */ - id?: string | undefined; - - /** - * Series name used for displaying in - * [tooltip](https://echarts.apache.org/en/option.html#tooltip) - * and filtering with - * [legend](https://echarts.apache.org/en/option.html#legend) - * , or updaing data and configuration with `setOption`. - * - * @see https://echarts.apache.org/en/option.html#series-map.name - */ - name?: string | undefined; - - /** - * 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 `