| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721 |
- /* *
- *
- * (c) 2010-2020 Torstein Honsi
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- 'use strict';
- import H from './Globals.js';
- /**
- * @typedef {"plotBox"|"spacingBox"} Highcharts.ButtonRelativeToValue
- */
- /**
- * Gets fired when a series is added to the chart after load time, using the
- * `addSeries` method. Returning `false` prevents the series from being added.
- *
- * @callback Highcharts.ChartAddSeriesCallbackFunction
- *
- * @param {Highcharts.Chart} this
- * The chart on which the event occured.
- *
- * @param {Highcharts.ChartAddSeriesEventObject} event
- * The event that occured.
- */
- /**
- * Contains common event information. Through the `options` property you can
- * access the series options that were passed to the `addSeries` method.
- *
- * @interface Highcharts.ChartAddSeriesEventObject
- */ /**
- * The series options that were passed to the `addSeries` method.
- * @name Highcharts.ChartAddSeriesEventObject#options
- * @type {Highcharts.SeriesOptionsType}
- */ /**
- * Prevents the default behaviour of the event.
- * @name Highcharts.ChartAddSeriesEventObject#preventDefault
- * @type {Function}
- */ /**
- * The event target.
- * @name Highcharts.ChartAddSeriesEventObject#target
- * @type {Highcharts.Chart}
- */ /**
- * The event type.
- * @name Highcharts.ChartAddSeriesEventObject#type
- * @type {"addSeries"}
- */
- /**
- * Gets fired when clicking on the plot background.
- *
- * @callback Highcharts.ChartClickCallbackFunction
- *
- * @param {Highcharts.Chart} this
- * The chart on which the event occured.
- *
- * @param {Highcharts.PointerEventObject} event
- * The event that occured.
- */
- /**
- * Contains an axes of the clicked spot.
- *
- * @interface Highcharts.ChartClickEventAxisObject
- */ /**
- * Axis at the clicked spot.
- * @name Highcharts.ChartClickEventAxisObject#axis
- * @type {Highcharts.Axis}
- */ /**
- * Axis value at the clicked spot.
- * @name Highcharts.ChartClickEventAxisObject#value
- * @type {number}
- */
- /**
- * Contains information about the clicked spot on the chart. Remember the unit
- * of a datetime axis is milliseconds since 1970-01-01 00:00:00.
- *
- * @interface Highcharts.ChartClickEventObject
- * @extends Highcharts.PointerEventObject
- */ /**
- * Information about the x-axis on the clicked spot.
- * @name Highcharts.ChartClickEventObject#xAxis
- * @type {Array<Highcharts.ChartClickEventAxisObject>}
- */ /**
- * Information about the y-axis on the clicked spot.
- * @name Highcharts.ChartClickEventObject#yAxis
- * @type {Array<Highcharts.ChartClickEventAxisObject>}
- */ /**
- * Information about the z-axis on the clicked spot.
- * @name Highcharts.ChartClickEventObject#zAxis
- * @type {Array<Highcharts.ChartClickEventAxisObject>|undefined}
- */
- /**
- * Gets fired when the chart is finished loading.
- *
- * @callback Highcharts.ChartLoadCallbackFunction
- *
- * @param {Highcharts.Chart} this
- * The chart on which the event occured.
- *
- * @param {global.Event} event
- * The event that occured.
- */
- /**
- * Fires when the chart is redrawn, either after a call to `chart.redraw()` or
- * after an axis, series or point is modified with the `redraw` option set to
- * `true`.
- *
- * @callback Highcharts.ChartRedrawCallbackFunction
- *
- * @param {Highcharts.Chart} this
- * The chart on which the event occured.
- *
- * @param {global.Event} event
- * The event that occured.
- */
- /**
- * Gets fired after initial load of the chart (directly after the `load` event),
- * and after each redraw (directly after the `redraw` event).
- *
- * @callback Highcharts.ChartRenderCallbackFunction
- *
- * @param {Highcharts.Chart} this
- * The chart on which the event occured.
- *
- * @param {global.Event} event
- * The event that occured.
- */
- /**
- * Gets fired when an area of the chart has been selected. The default action
- * for the selection event is to zoom the chart to the selected area. It can be
- * prevented by calling `event.preventDefault()` or return false.
- *
- * @callback Highcharts.ChartSelectionCallbackFunction
- *
- * @param {Highcharts.Chart} this
- * The chart on which the event occured.
- *
- * @param {global.ChartSelectionContextObject} event
- * Event informations
- *
- * @return {boolean|undefined}
- * Return false to prevent the default action, usually zoom.
- */
- /**
- * The primary axes are `xAxis[0]` and `yAxis[0]`. Remember the unit of a
- * datetime axis is milliseconds since 1970-01-01 00:00:00.
- *
- * @interface Highcharts.ChartSelectionContextObject
- * @extends global.Event
- */ /**
- * Arrays containing the axes of each dimension and each axis' min and max
- * values.
- * @name Highcharts.ChartSelectionContextObject#xAxis
- * @type {Array<Highcharts.ChartSelectionAxisContextObject>}
- */ /**
- * Arrays containing the axes of each dimension and each axis' min and max
- * values.
- * @name Highcharts.ChartSelectionContextObject#yAxis
- * @type {Array<Highcharts.ChartSelectionAxisContextObject>}
- */
- /**
- * Axis context of the selection.
- *
- * @interface Highcharts.ChartSelectionAxisContextObject
- */ /**
- * The selected Axis.
- * @name Highcharts.ChartSelectionAxisContextObject#axis
- * @type {Highcharts.Axis}
- */ /**
- * The maximum axis value, either automatic or set manually.
- * @name Highcharts.ChartSelectionAxisContextObject#max
- * @type {number}
- */ /**
- * The minimum axis value, either automatic or set manually.
- * @name Highcharts.ChartSelectionAxisContextObject#min
- * @type {number}
- */
- import Time from './Time.js';
- import Color from './Color.js';
- var color = Color.parse;
- import U from './Utilities.js';
- var merge = U.merge;
- var isTouchDevice = H.isTouchDevice, svg = H.svg;
- /* ************************************************************************** *
- * Handle the options *
- * ************************************************************************** */
- /**
- * Global default settings.
- *
- * @name Highcharts.defaultOptions
- * @type {Highcharts.Options}
- */ /**
- * @optionparent
- */
- H.defaultOptions = {
- /**
- * An array containing the default colors for the chart's series. When
- * all colors are used, new colors are pulled from the start again.
- *
- * Default colors can also be set on a series or series.type basis,
- * see [column.colors](#plotOptions.column.colors),
- * [pie.colors](#plotOptions.pie.colors).
- *
- * In styled mode, the colors option doesn't exist. Instead, colors
- * are defined in CSS and applied either through series or point class
- * names, or through the [chart.colorCount](#chart.colorCount) option.
- *
- *
- * ### Legacy
- *
- * In Highcharts 3.x, the default colors were:
- * ```js
- * colors: ['#2f7ed8', '#0d233a', '#8bbc21', '#910000', '#1aadce',
- * '#492970', '#f28f43', '#77a1e5', '#c42525', '#a6c96a']
- * ```
- *
- * In Highcharts 2.x, the default colors were:
- * ```js
- * colors: ['#4572A7', '#AA4643', '#89A54E', '#80699B', '#3D96AE',
- * '#DB843D', '#92A8CD', '#A47D7C', '#B5CA92']
- * ```
- *
- * @sample {highcharts} highcharts/chart/colors/
- * Assign a global color theme
- *
- * @type {Array<Highcharts.ColorString>}
- * @default ["#7cb5ec", "#434348", "#90ed7d", "#f7a35c", "#8085e9",
- * "#f15c80", "#e4d354", "#2b908f", "#f45b5b", "#91e8e1"]
- */
- colors: '#7cb5ec #434348 #90ed7d #f7a35c #8085e9 #f15c80 #e4d354 #2b908f #f45b5b #91e8e1'.split(' '),
- /**
- * Styled mode only. Configuration object for adding SVG definitions for
- * reusable elements. See [gradients, shadows and
- * patterns](https://www.highcharts.com/docs/chart-design-and-style/gradients-shadows-and-patterns)
- * for more information and code examples.
- *
- * @type {*}
- * @since 5.0.0
- * @apioption defs
- */
- /**
- * @ignore-option
- */
- symbols: ['circle', 'diamond', 'square', 'triangle', 'triangle-down'],
- /**
- * The language object is global and it can't be set on each chart
- * initialization. Instead, use `Highcharts.setOptions` to set it before any
- * chart is initialized.
- *
- * ```js
- * Highcharts.setOptions({
- * lang: {
- * months: [
- * 'Janvier', 'Février', 'Mars', 'Avril',
- * 'Mai', 'Juin', 'Juillet', 'Août',
- * 'Septembre', 'Octobre', 'Novembre', 'Décembre'
- * ],
- * weekdays: [
- * 'Dimanche', 'Lundi', 'Mardi', 'Mercredi',
- * 'Jeudi', 'Vendredi', 'Samedi'
- * ]
- * }
- * });
- * ```
- */
- lang: {
- /**
- * The loading text that appears when the chart is set into the loading
- * state following a call to `chart.showLoading`.
- */
- loading: 'Loading...',
- /**
- * An array containing the months names. Corresponds to the `%B` format
- * in `Highcharts.dateFormat()`.
- *
- * @type {Array<string>}
- * @default ["January", "February", "March", "April", "May", "June",
- * "July", "August", "September", "October", "November",
- * "December"]
- */
- months: [
- 'January', 'February', 'March', 'April', 'May', 'June', 'July',
- 'August', 'September', 'October', 'November', 'December'
- ],
- /**
- * An array containing the months names in abbreviated form. Corresponds
- * to the `%b` format in `Highcharts.dateFormat()`.
- *
- * @type {Array<string>}
- * @default ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
- * "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
- */
- shortMonths: [
- 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul',
- 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
- ],
- /**
- * An array containing the weekday names.
- *
- * @type {Array<string>}
- * @default ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday",
- * "Friday", "Saturday"]
- */
- weekdays: [
- 'Sunday', 'Monday', 'Tuesday', 'Wednesday',
- 'Thursday', 'Friday', 'Saturday'
- ],
- /**
- * Short week days, starting Sunday. If not specified, Highcharts uses
- * the first three letters of the `lang.weekdays` option.
- *
- * @sample highcharts/lang/shortweekdays/
- * Finnish two-letter abbreviations
- *
- * @type {Array<string>}
- * @since 4.2.4
- * @apioption lang.shortWeekdays
- */
- /**
- * What to show in a date field for invalid dates. Defaults to an empty
- * string.
- *
- * @type {string}
- * @since 4.1.8
- * @product highcharts highstock
- * @apioption lang.invalidDate
- */
- /**
- * The title appearing on hovering the zoom in button. The text itself
- * defaults to "+" and can be changed in the button options.
- *
- * @type {string}
- * @default Zoom in
- * @product highmaps
- * @apioption lang.zoomIn
- */
- /**
- * The title appearing on hovering the zoom out button. The text itself
- * defaults to "-" and can be changed in the button options.
- *
- * @type {string}
- * @default Zoom out
- * @product highmaps
- * @apioption lang.zoomOut
- */
- /**
- * The default decimal point used in the `Highcharts.numberFormat`
- * method unless otherwise specified in the function arguments.
- *
- * @since 1.2.2
- */
- decimalPoint: '.',
- /**
- * [Metric prefixes](https://en.wikipedia.org/wiki/Metric_prefix) used
- * to shorten high numbers in axis labels. Replacing any of the
- * positions with `null` causes the full number to be written. Setting
- * `numericSymbols` to `null` disables shortening altogether.
- *
- * @sample {highcharts} highcharts/lang/numericsymbols/
- * Replacing the symbols with text
- * @sample {highstock} highcharts/lang/numericsymbols/
- * Replacing the symbols with text
- *
- * @type {Array<string>}
- * @default ["k", "M", "G", "T", "P", "E"]
- * @since 2.3.0
- */
- numericSymbols: ['k', 'M', 'G', 'T', 'P', 'E'],
- /**
- * The magnitude of [numericSymbols](#lang.numericSymbol) replacements.
- * Use 10000 for Japanese, Korean and various Chinese locales, which
- * use symbols for 10^4, 10^8 and 10^12.
- *
- * @sample highcharts/lang/numericsymbolmagnitude/
- * 10000 magnitude for Japanese
- *
- * @type {number}
- * @default 1000
- * @since 5.0.3
- * @apioption lang.numericSymbolMagnitude
- */
- /**
- * The text for the label appearing when a chart is zoomed.
- *
- * @since 1.2.4
- */
- resetZoom: 'Reset zoom',
- /**
- * The tooltip title for the label appearing when a chart is zoomed.
- *
- * @since 1.2.4
- */
- resetZoomTitle: 'Reset zoom level 1:1',
- /**
- * The default thousands separator used in the `Highcharts.numberFormat`
- * method unless otherwise specified in the function arguments. Defaults
- * to a single space character, which is recommended in
- * [ISO 31-0](https://en.wikipedia.org/wiki/ISO_31-0#Numbers) and works
- * across Anglo-American and continental European languages.
- *
- * @default \u0020
- * @since 1.2.2
- */
- thousandsSep: ' '
- },
- /**
- * Global options that don't apply to each chart. These options, like
- * the `lang` options, must be set using the `Highcharts.setOptions`
- * method.
- *
- * ```js
- * Highcharts.setOptions({
- * global: {
- * useUTC: false
- * }
- * });
- * ```
- */
- /**
- * _Canvg rendering for Android 2.x is removed as of Highcharts 5.0\.
- * Use the [libURL](#exporting.libURL) option to configure exporting._
- *
- * The URL to the additional file to lazy load for Android 2.x devices.
- * These devices don't support SVG, so we download a helper file that
- * contains [canvg](https://github.com/canvg/canvg), its dependency
- * rbcolor, and our own CanVG Renderer class. To avoid hotlinking to
- * our site, you can install canvas-tools.js on your own server and
- * change this option accordingly.
- *
- * @deprecated
- *
- * @type {string}
- * @default https://code.highcharts.com/{version}/modules/canvas-tools.js
- * @product highcharts highmaps
- * @apioption global.canvasToolsURL
- */
- /**
- * This option is deprecated since v6.0.5. Instead, use
- * [time.useUTC](#time.useUTC) that supports individual time settings
- * per chart.
- *
- * @deprecated
- *
- * @type {boolean}
- * @apioption global.useUTC
- */
- /**
- * This option is deprecated since v6.0.5. Instead, use
- * [time.Date](#time.Date) that supports individual time settings
- * per chart.
- *
- * @deprecated
- *
- * @type {Function}
- * @product highcharts highstock
- * @apioption global.Date
- */
- /**
- * This option is deprecated since v6.0.5. Instead, use
- * [time.getTimezoneOffset](#time.getTimezoneOffset) that supports
- * individual time settings per chart.
- *
- * @deprecated
- *
- * @type {Function}
- * @product highcharts highstock
- * @apioption global.getTimezoneOffset
- */
- /**
- * This option is deprecated since v6.0.5. Instead, use
- * [time.timezone](#time.timezone) that supports individual time
- * settings per chart.
- *
- * @deprecated
- *
- * @type {string}
- * @product highcharts highstock
- * @apioption global.timezone
- */
- /**
- * This option is deprecated since v6.0.5. Instead, use
- * [time.timezoneOffset](#time.timezoneOffset) that supports individual
- * time settings per chart.
- *
- * @deprecated
- *
- * @type {number}
- * @product highcharts highstock
- * @apioption global.timezoneOffset
- */
- global: {},
- /**
- * Time options that can apply globally or to individual charts. These
- * settings affect how `datetime` axes are laid out, how tooltips are
- * formatted, how series
- * [pointIntervalUnit](#plotOptions.series.pointIntervalUnit) works and how
- * the Highstock range selector handles time.
- *
- * The common use case is that all charts in the same Highcharts object
- * share the same time settings, in which case the global settings are set
- * using `setOptions`.
- *
- * ```js
- * // Apply time settings globally
- * Highcharts.setOptions({
- * time: {
- * timezone: 'Europe/London'
- * }
- * });
- * // Apply time settings by instance
- * var chart = Highcharts.chart('container', {
- * time: {
- * timezone: 'America/New_York'
- * },
- * series: [{
- * data: [1, 4, 3, 5]
- * }]
- * });
- *
- * // Use the Time object
- * console.log(
- * 'Current time in New York',
- * chart.time.dateFormat('%Y-%m-%d %H:%M:%S', Date.now())
- * );
- * ```
- *
- * Since v6.0.5, the time options were moved from the `global` obect to the
- * `time` object, and time options can be set on each individual chart.
- *
- * @sample {highcharts|highstock}
- * highcharts/time/timezone/
- * Set the timezone globally
- * @sample {highcharts}
- * highcharts/time/individual/
- * Set the timezone per chart instance
- * @sample {highstock}
- * stock/time/individual/
- * Set the timezone per chart instance
- *
- * @since 6.0.5
- * @optionparent time
- */
- time: {
- /**
- * A custom `Date` class for advanced date handling. For example,
- * [JDate](https://github.com/tahajahangir/jdate) can be hooked in to
- * handle Jalali dates.
- *
- * @type {*}
- * @since 4.0.4
- * @product highcharts highstock gantt
- */
- Date: void 0,
- /**
- * A callback to return the time zone offset for a given datetime. It
- * takes the timestamp in terms of milliseconds since January 1 1970,
- * and returns the timezone offset in minutes. This provides a hook
- * for drawing time based charts in specific time zones using their
- * local DST crossover dates, with the help of external libraries.
- *
- * @see [global.timezoneOffset](#global.timezoneOffset)
- *
- * @sample {highcharts|highstock} highcharts/time/gettimezoneoffset/
- * Use moment.js to draw Oslo time regardless of browser locale
- *
- * @type {Highcharts.TimezoneOffsetCallbackFunction}
- * @since 4.1.0
- * @product highcharts highstock gantt
- */
- getTimezoneOffset: void 0,
- /**
- * Requires [moment.js](https://momentjs.com/). If the timezone option
- * is specified, it creates a default
- * [getTimezoneOffset](#time.getTimezoneOffset) function that looks
- * up the specified timezone in moment.js. If moment.js is not included,
- * this throws a Highcharts error in the console, but does not crash the
- * chart.
- *
- * @see [getTimezoneOffset](#time.getTimezoneOffset)
- *
- * @sample {highcharts|highstock} highcharts/time/timezone/
- * Europe/Oslo
- *
- * @type {string}
- * @since 5.0.7
- * @product highcharts highstock gantt
- */
- timezone: void 0,
- /**
- * The timezone offset in minutes. Positive values are west, negative
- * values are east of UTC, as in the ECMAScript
- * [getTimezoneOffset](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset)
- * method. Use this to display UTC based data in a predefined time zone.
- *
- * @see [time.getTimezoneOffset](#time.getTimezoneOffset)
- *
- * @sample {highcharts|highstock} highcharts/time/timezoneoffset/
- * Timezone offset
- *
- * @since 3.0.8
- * @product highcharts highstock gantt
- */
- timezoneOffset: 0,
- /**
- * Whether to use UTC time for axis scaling, tickmark placement and
- * time display in `Highcharts.dateFormat`. Advantages of using UTC
- * is that the time displays equally regardless of the user agent's
- * time zone settings. Local time can be used when the data is loaded
- * in real time or when correct Daylight Saving Time transitions are
- * required.
- *
- * @sample {highcharts} highcharts/time/useutc-true/
- * True by default
- * @sample {highcharts} highcharts/time/useutc-false/
- * False
- */
- useUTC: true
- },
- /**
- * General options for the chart.
- */
- chart: {
- /**
- * Default `mapData` for all series. If set to a string, it functions
- * as an index into the `Highcharts.maps` array. Otherwise it is
- * interpreted as map data.
- *
- * @see [mapData](#series.map.mapData)
- *
- * @sample maps/demo/geojson
- * Loading geoJSON data
- * @sample maps/chart/topojson
- * Loading topoJSON converted to geoJSON
- *
- * @type {string|Array<*>|Highcharts.GeoJSON}
- * @since 5.0.0
- * @product highmaps
- * @apioption chart.map
- */
- /**
- * Set lat/lon transformation definitions for the chart. If not defined,
- * these are extracted from the map data.
- *
- * @type {*}
- * @since 5.0.0
- * @product highmaps
- * @apioption chart.mapTransforms
- */
- /**
- * When using multiple axis, the ticks of two or more opposite axes
- * will automatically be aligned by adding ticks to the axis or axes
- * with the least ticks, as if `tickAmount` were specified.
- *
- * This can be prevented by setting `alignTicks` to false. If the grid
- * lines look messy, it's a good idea to hide them for the secondary
- * axis by setting `gridLineWidth` to 0.
- *
- * If `startOnTick` or `endOnTick` in an Axis options are set to false,
- * then the `alignTicks ` will be disabled for the Axis.
- *
- * Disabled for logarithmic axes.
- *
- * @sample {highcharts} highcharts/chart/alignticks-true/
- * True by default
- * @sample {highcharts} highcharts/chart/alignticks-false/
- * False
- * @sample {highstock} stock/chart/alignticks-true/
- * True by default
- * @sample {highstock} stock/chart/alignticks-false/
- * False
- *
- * @type {boolean}
- * @default true
- * @product highcharts highstock gantt
- * @apioption chart.alignTicks
- */
- /**
- * Set the overall animation for all chart updating. Animation can be
- * disabled throughout the chart by setting it to false here. It can
- * be overridden for each individual API method as a function parameter.
- * The only animation not affected by this option is the initial series
- * animation, see [plotOptions.series.animation](
- * #plotOptions.series.animation).
- *
- * The animation can either be set as a boolean or a configuration
- * object. If `true`, it will use the 'swing' jQuery easing and a
- * duration of 500 ms. If used as a configuration object, the following
- * properties are supported:
- *
- * - `defer`: The animation delay time in milliseconds.
- *
- * - `duration`: The duration of the animation in milliseconds.
- *
- * - `easing`: A string reference to an easing function set on the
- * `Math` object. See
- * [the easing demo](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-animation-easing/).
- *
- * When zooming on a series with less than 100 points, the chart redraw
- * will be done with animation, but in case of more data points, it is
- * necessary to set this option to ensure animation on zoom.
- *
- * @sample {highcharts} highcharts/chart/animation-none/
- * Updating with no animation
- * @sample {highcharts} highcharts/chart/animation-duration/
- * With a longer duration
- * @sample {highcharts} highcharts/chart/animation-easing/
- * With a jQuery UI easing
- * @sample {highmaps} maps/chart/animation-none/
- * Updating with no animation
- * @sample {highmaps} maps/chart/animation-duration/
- * With a longer duration
- *
- * @type {boolean|Partial<Highcharts.AnimationOptionsObject>}
- * @default undefined
- * @apioption chart.animation
- */
- /**
- * A CSS class name to apply to the charts container `div`, allowing
- * unique CSS styling for each chart.
- *
- * @type {string}
- * @apioption chart.className
- */
- /**
- * Event listeners for the chart.
- *
- * @apioption chart.events
- */
- /**
- * Fires when a series is added to the chart after load time, using the
- * `addSeries` method. One parameter, `event`, is passed to the
- * function, containing common event information. Through
- * `event.options` you can access the series options that were passed to
- * the `addSeries` method. Returning false prevents the series from
- * being added.
- *
- * @sample {highcharts} highcharts/chart/events-addseries/
- * Alert on add series
- * @sample {highstock} stock/chart/events-addseries/
- * Alert on add series
- *
- * @type {Highcharts.ChartAddSeriesCallbackFunction}
- * @since 1.2.0
- * @context Highcharts.Chart
- * @apioption chart.events.addSeries
- */
- /**
- * Fires when clicking on the plot background. One parameter, `event`,
- * is passed to the function, containing common event information.
- *
- * Information on the clicked spot can be found through `event.xAxis`
- * and `event.yAxis`, which are arrays containing the axes of each
- * dimension and each axis' value at the clicked spot. The primary axes
- * are `event.xAxis[0]` and `event.yAxis[0]`. Remember the unit of a
- * datetime axis is milliseconds since 1970-01-01 00:00:00.
- *
- * ```js
- * click: function(e) {
- * console.log(
- * Highcharts.dateFormat('%Y-%m-%d %H:%M:%S', e.xAxis[0].value),
- * e.yAxis[0].value
- * )
- * }
- * ```
- *
- * @sample {highcharts} highcharts/chart/events-click/
- * Alert coordinates on click
- * @sample {highcharts} highcharts/chart/events-container/
- * Alternatively, attach event to container
- * @sample {highstock} stock/chart/events-click/
- * Alert coordinates on click
- * @sample {highstock} highcharts/chart/events-container/
- * Alternatively, attach event to container
- * @sample {highmaps} maps/chart/events-click/
- * Record coordinates on click
- * @sample {highmaps} highcharts/chart/events-container/
- * Alternatively, attach event to container
- *
- * @type {Highcharts.ChartClickCallbackFunction}
- * @since 1.2.0
- * @context Highcharts.Chart
- * @apioption chart.events.click
- */
- /**
- * Fires when the chart is finished loading. Since v4.2.2, it also waits
- * for images to be loaded, for example from point markers. One
- * parameter, `event`, is passed to the function, containing common
- * event information.
- *
- * There is also a second parameter to the chart constructor where a
- * callback function can be passed to be executed on chart.load.
- *
- * @sample {highcharts} highcharts/chart/events-load/
- * Alert on chart load
- * @sample {highstock} stock/chart/events-load/
- * Alert on chart load
- * @sample {highmaps} maps/chart/events-load/
- * Add series on chart load
- *
- * @type {Highcharts.ChartLoadCallbackFunction}
- * @context Highcharts.Chart
- * @apioption chart.events.load
- */
- /**
- * Fires when the chart is redrawn, either after a call to
- * `chart.redraw()` or after an axis, series or point is modified with
- * the `redraw` option set to `true`. One parameter, `event`, is passed
- * to the function, containing common event information.
- *
- * @sample {highcharts} highcharts/chart/events-redraw/
- * Alert on chart redraw
- * @sample {highstock} stock/chart/events-redraw/
- * Alert on chart redraw when adding a series or moving the
- * zoomed range
- * @sample {highmaps} maps/chart/events-redraw/
- * Set subtitle on chart redraw
- *
- * @type {Highcharts.ChartRedrawCallbackFunction}
- * @since 1.2.0
- * @context Highcharts.Chart
- * @apioption chart.events.redraw
- */
- /**
- * Fires after initial load of the chart (directly after the `load`
- * event), and after each redraw (directly after the `redraw` event).
- *
- * @type {Highcharts.ChartRenderCallbackFunction}
- * @since 5.0.7
- * @context Highcharts.Chart
- * @apioption chart.events.render
- */
- /**
- * Fires when an area of the chart has been selected. Selection is
- * enabled by setting the chart's zoomType. One parameter, `event`, is
- * passed to the function, containing common event information. The
- * default action for the selection event is to zoom the chart to the
- * selected area. It can be prevented by calling
- * `event.preventDefault()` or return false.
- *
- * Information on the selected area can be found through `event.xAxis`
- * and `event.yAxis`, which are arrays containing the axes of each
- * dimension and each axis' min and max values. The primary axes are
- * `event.xAxis[0]` and `event.yAxis[0]`. Remember the unit of a
- * datetime axis is milliseconds since 1970-01-01 00:00:00.
- *
- * ```js
- * selection: function(event) {
- * // log the min and max of the primary, datetime x-axis
- * console.log(
- * Highcharts.dateFormat(
- * '%Y-%m-%d %H:%M:%S',
- * event.xAxis[0].min
- * ),
- * Highcharts.dateFormat(
- * '%Y-%m-%d %H:%M:%S',
- * event.xAxis[0].max
- * )
- * );
- * // log the min and max of the y axis
- * console.log(event.yAxis[0].min, event.yAxis[0].max);
- * }
- * ```
- *
- * @sample {highcharts} highcharts/chart/events-selection/
- * Report on selection and reset
- * @sample {highcharts} highcharts/chart/events-selection-points/
- * Select a range of points through a drag selection
- * @sample {highstock} stock/chart/events-selection/
- * Report on selection and reset
- * @sample {highstock} highcharts/chart/events-selection-points/
- * Select a range of points through a drag selection
- * (Highcharts)
- *
- * @type {Highcharts.ChartSelectionCallbackFunction}
- * @apioption chart.events.selection
- */
- /**
- * The margin between the outer edge of the chart and the plot area.
- * The numbers in the array designate top, right, bottom and left
- * respectively. Use the options `marginTop`, `marginRight`,
- * `marginBottom` and `marginLeft` for shorthand setting of one option.
- *
- * By default there is no margin. The actual space is dynamically
- * calculated from the offset of axis labels, axis title, title,
- * subtitle and legend in addition to the `spacingTop`, `spacingRight`,
- * `spacingBottom` and `spacingLeft` options.
- *
- * @sample {highcharts} highcharts/chart/margins-zero/
- * Zero margins
- * @sample {highstock} stock/chart/margin-zero/
- * Zero margins
- *
- * @type {number|Array<number>}
- * @apioption chart.margin
- */
- /**
- * The margin between the bottom outer edge of the chart and the plot
- * area. Use this to set a fixed pixel value for the margin as opposed
- * to the default dynamic margin. See also `spacingBottom`.
- *
- * @sample {highcharts} highcharts/chart/marginbottom/
- * 100px bottom margin
- * @sample {highstock} stock/chart/marginbottom/
- * 100px bottom margin
- * @sample {highmaps} maps/chart/margin/
- * 100px margins
- *
- * @type {number}
- * @since 2.0
- * @apioption chart.marginBottom
- */
- /**
- * The margin between the left outer edge of the chart and the plot
- * area. Use this to set a fixed pixel value for the margin as opposed
- * to the default dynamic margin. See also `spacingLeft`.
- *
- * @sample {highcharts} highcharts/chart/marginleft/
- * 150px left margin
- * @sample {highstock} stock/chart/marginleft/
- * 150px left margin
- * @sample {highmaps} maps/chart/margin/
- * 100px margins
- *
- * @type {number}
- * @since 2.0
- * @apioption chart.marginLeft
- */
- /**
- * The margin between the right outer edge of the chart and the plot
- * area. Use this to set a fixed pixel value for the margin as opposed
- * to the default dynamic margin. See also `spacingRight`.
- *
- * @sample {highcharts} highcharts/chart/marginright/
- * 100px right margin
- * @sample {highstock} stock/chart/marginright/
- * 100px right margin
- * @sample {highmaps} maps/chart/margin/
- * 100px margins
- *
- * @type {number}
- * @since 2.0
- * @apioption chart.marginRight
- */
- /**
- * The margin between the top outer edge of the chart and the plot area.
- * Use this to set a fixed pixel value for the margin as opposed to
- * the default dynamic margin. See also `spacingTop`.
- *
- * @sample {highcharts} highcharts/chart/margintop/ 100px top margin
- * @sample {highstock} stock/chart/margintop/
- * 100px top margin
- * @sample {highmaps} maps/chart/margin/
- * 100px margins
- *
- * @type {number}
- * @since 2.0
- * @apioption chart.marginTop
- */
- /**
- * Callback function to override the default function that formats all
- * the numbers in the chart. Returns a string with the formatted number.
- *
- * @sample highcharts/members/highcharts-numberformat
- * Arabic digits in Highcharts
- * @type {Highcharts.NumberFormatterCallbackFunction}
- * @since 8.0.0
- * @apioption chart.numberFormatter
- */
- /**
- * Allows setting a key to switch between zooming and panning. Can be
- * one of `alt`, `ctrl`, `meta` (the command key on Mac and Windows
- * key on Windows) or `shift`. The keys are mapped directly to the key
- * properties of the click event argument (`event.altKey`,
- * `event.ctrlKey`, `event.metaKey` and `event.shiftKey`).
- *
- * @type {string}
- * @since 4.0.3
- * @product highcharts gantt
- * @validvalue ["alt", "ctrl", "meta", "shift"]
- * @apioption chart.panKey
- */
- /**
- * Allow panning in a chart. Best used with [panKey](#chart.panKey)
- * to combine zooming and panning.
- *
- * On touch devices, when the [tooltip.followTouchMove](
- * #tooltip.followTouchMove) option is `true` (default), panning
- * requires two fingers. To allow panning with one finger, set
- * `followTouchMove` to `false`.
- *
- * @sample {highcharts} highcharts/chart/pankey/ Zooming and panning
- * @sample {highstock} stock/chart/panning/ Zooming and xy panning
- *
- * @product highcharts highstock gantt
- * @apioption chart.panning
- */
- /**
- * Enable or disable chart panning.
- *
- * @type {boolean}
- * @default {highcharts} false
- * @default {highstock} true
- * @apioption chart.panning.enabled
- */
- /**
- * Decides in what dimensions the user can pan the chart. Can be
- * one of `x`, `y`, or `xy`.
- *
- * @sample {highcharts} highcharts/chart/panning-type
- * Zooming and xy panning
- *
- * @type {string}
- * @validvalue ["x", "y", "xy"]
- * @default x
- * @apioption chart.panning.type
- */
- /**
- * Equivalent to [zoomType](#chart.zoomType), but for multitouch
- * gestures only. By default, the `pinchType` is the same as the
- * `zoomType` setting. However, pinching can be enabled separately in
- * some cases, for example in stock charts where a mouse drag pans the
- * chart, while pinching is enabled. When [tooltip.followTouchMove](
- * #tooltip.followTouchMove) is true, pinchType only applies to
- * two-finger touches.
- *
- * @type {string}
- * @default {highcharts} undefined
- * @default {highstock} x
- * @since 3.0
- * @product highcharts highstock gantt
- * @validvalue ["x", "y", "xy"]
- * @apioption chart.pinchType
- */
- /**
- * Whether to apply styled mode. When in styled mode, no presentational
- * attributes or CSS are applied to the chart SVG. Instead, CSS rules
- * are required to style the chart. The default style sheet is
- * available from `https://code.highcharts.com/css/highcharts.css`.
- *
- * @type {boolean}
- * @default false
- * @since 7.0
- * @apioption chart.styledMode
- */
- styledMode: false,
- /**
- * The corner radius of the outer chart border.
- *
- * @sample {highcharts} highcharts/chart/borderradius/
- * 20px radius
- * @sample {highstock} stock/chart/border/
- * 10px radius
- * @sample {highmaps} maps/chart/border/
- * Border options
- *
- */
- borderRadius: 0,
- /**
- * In styled mode, this sets how many colors the class names
- * should rotate between. With ten colors, series (or points) are
- * given class names like `highcharts-color-0`, `highcharts-color-0`
- * [...] `highcharts-color-9`. The equivalent in non-styled mode
- * is to set colors using the [colors](#colors) setting.
- *
- * @since 5.0.0
- */
- colorCount: 10,
- /**
- * Alias of `type`.
- *
- * @sample {highcharts} highcharts/chart/defaultseriestype/
- * Bar
- *
- * @deprecated
- *
- * @product highcharts
- */
- defaultSeriesType: 'line',
- /**
- * If true, the axes will scale to the remaining visible series once
- * one series is hidden. If false, hiding and showing a series will
- * not affect the axes or the other series. For stacks, once one series
- * within the stack is hidden, the rest of the stack will close in
- * around it even if the axis is not affected.
- *
- * @sample {highcharts} highcharts/chart/ignorehiddenseries-true/
- * True by default
- * @sample {highcharts} highcharts/chart/ignorehiddenseries-false/
- * False
- * @sample {highcharts} highcharts/chart/ignorehiddenseries-true-stacked/
- * True with stack
- * @sample {highstock} stock/chart/ignorehiddenseries-true/
- * True by default
- * @sample {highstock} stock/chart/ignorehiddenseries-false/
- * False
- *
- * @since 1.2.0
- * @product highcharts highstock gantt
- */
- ignoreHiddenSeries: true,
- /**
- * Whether to invert the axes so that the x axis is vertical and y axis
- * is horizontal. When `true`, the x axis is [reversed](#xAxis.reversed)
- * by default.
- *
- * @productdesc {highcharts}
- * If a bar series is present in the chart, it will be inverted
- * automatically. Inverting the chart doesn't have an effect if there
- * are no cartesian series in the chart, or if the chart is
- * [polar](#chart.polar).
- *
- * @sample {highcharts} highcharts/chart/inverted/
- * Inverted line
- * @sample {highstock} stock/navigator/inverted/
- * Inverted stock chart
- *
- * @type {boolean}
- * @default false
- * @product highcharts highstock gantt
- * @apioption chart.inverted
- */
- /**
- * The distance between the outer edge of the chart and the content,
- * like title or legend, or axis title and labels if present. The
- * numbers in the array designate top, right, bottom and left
- * respectively. Use the options spacingTop, spacingRight, spacingBottom
- * and spacingLeft options for shorthand setting of one option.
- *
- * @type {Array<number>}
- * @see [chart.margin](#chart.margin)
- * @default [10, 10, 15, 10]
- * @since 3.0.6
- */
- spacing: [10, 10, 15, 10],
- /**
- * The button that appears after a selection zoom, allowing the user
- * to reset zoom.
- */
- resetZoomButton: {
- /**
- * What frame the button placement should be related to. Can be
- * either `plotBox` or `spacingBox`.
- *
- * @sample {highcharts} highcharts/chart/resetzoombutton-relativeto/
- * Relative to the chart
- * @sample {highstock} highcharts/chart/resetzoombutton-relativeto/
- * Relative to the chart
- *
- * @type {Highcharts.ButtonRelativeToValue}
- * @default plot
- * @since 2.2
- * @apioption chart.resetZoomButton.relativeTo
- */
- /**
- * A collection of attributes for the button. The object takes SVG
- * attributes like `fill`, `stroke`, `stroke-width` or `r`, the
- * border radius. The theme also supports `style`, a collection of
- * CSS properties for the text. Equivalent attributes for the hover
- * state are given in `theme.states.hover`.
- *
- * @sample {highcharts} highcharts/chart/resetzoombutton-theme/
- * Theming the button
- * @sample {highstock} highcharts/chart/resetzoombutton-theme/
- * Theming the button
- *
- * @type {Highcharts.SVGAttributes}
- * @since 2.2
- */
- theme: {
- /** @internal */
- zIndex: 6
- },
- /**
- * The position of the button.
- *
- * @sample {highcharts} highcharts/chart/resetzoombutton-position/
- * Above the plot area
- * @sample {highstock} highcharts/chart/resetzoombutton-position/
- * Above the plot area
- * @sample {highmaps} highcharts/chart/resetzoombutton-position/
- * Above the plot area
- *
- * @type {Highcharts.AlignObject}
- * @since 2.2
- */
- position: {
- /**
- * The horizontal alignment of the button.
- */
- align: 'right',
- /**
- * The horizontal offset of the button.
- */
- x: -10,
- /**
- * The vertical alignment of the button.
- *
- * @type {Highcharts.VerticalAlignValue}
- * @default top
- * @apioption chart.resetZoomButton.position.verticalAlign
- */
- /**
- * The vertical offset of the button.
- */
- y: 10
- }
- },
- /**
- * The pixel width of the plot area border.
- *
- * @sample {highcharts} highcharts/chart/plotborderwidth/
- * 1px border
- * @sample {highstock} stock/chart/plotborder/
- * 2px border
- * @sample {highmaps} maps/chart/plotborder/
- * Plot border options
- *
- * @type {number}
- * @default 0
- * @apioption chart.plotBorderWidth
- */
- /**
- * Whether to apply a drop shadow to the plot area. Requires that
- * plotBackgroundColor be set. The shadow can be an object configuration
- * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
- *
- * @sample {highcharts} highcharts/chart/plotshadow/
- * Plot shadow
- * @sample {highstock} stock/chart/plotshadow/
- * Plot shadow
- * @sample {highmaps} maps/chart/plotborder/
- * Plot border options
- *
- * @type {boolean|Highcharts.CSSObject}
- * @default false
- * @apioption chart.plotShadow
- */
- /**
- * When true, cartesian charts like line, spline, area and column are
- * transformed into the polar coordinate system. This produces _polar
- * charts_, also known as _radar charts_.
- *
- * @sample {highcharts} highcharts/demo/polar/
- * Polar chart
- * @sample {highcharts} highcharts/demo/polar-wind-rose/
- * Wind rose, stacked polar column chart
- * @sample {highcharts} highcharts/demo/polar-spider/
- * Spider web chart
- * @sample {highcharts} highcharts/parallel-coordinates/polar/
- * Star plot, multivariate data in a polar chart
- *
- * @type {boolean}
- * @default false
- * @since 2.3.0
- * @product highcharts
- * @requires highcharts-more
- * @apioption chart.polar
- */
- /**
- * Whether to reflow the chart to fit the width of the container div
- * on resizing the window.
- *
- * @sample {highcharts} highcharts/chart/reflow-true/
- * True by default
- * @sample {highcharts} highcharts/chart/reflow-false/
- * False
- * @sample {highstock} stock/chart/reflow-true/
- * True by default
- * @sample {highstock} stock/chart/reflow-false/
- * False
- * @sample {highmaps} maps/chart/reflow-true/
- * True by default
- * @sample {highmaps} maps/chart/reflow-false/
- * False
- *
- * @type {boolean}
- * @default true
- * @since 2.1
- * @apioption chart.reflow
- */
- /**
- * The HTML element where the chart will be rendered. If it is a string,
- * the element by that id is used. The HTML element can also be passed
- * by direct reference, or as the first argument of the chart
- * constructor, in which case the option is not needed.
- *
- * @sample {highcharts} highcharts/chart/reflow-true/
- * String
- * @sample {highcharts} highcharts/chart/renderto-object/
- * Object reference
- * @sample {highcharts} highcharts/chart/renderto-jquery/
- * Object reference through jQuery
- * @sample {highstock} stock/chart/renderto-string/
- * String
- * @sample {highstock} stock/chart/renderto-object/
- * Object reference
- * @sample {highstock} stock/chart/renderto-jquery/
- * Object reference through jQuery
- *
- * @type {string|Highcharts.HTMLDOMElement}
- * @apioption chart.renderTo
- */
- /**
- * The background color of the marker square when selecting (zooming
- * in on) an area of the chart.
- *
- * @see In styled mode, the selection marker fill is set with the
- * `.highcharts-selection-marker` class.
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- * @default rgba(51,92,173,0.25)
- * @since 2.1.7
- * @apioption chart.selectionMarkerFill
- */
- /**
- * Whether to apply a drop shadow to the outer chart area. Requires
- * that backgroundColor be set. The shadow can be an object
- * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
- * `width`.
- *
- * @sample {highcharts} highcharts/chart/shadow/
- * Shadow
- * @sample {highstock} stock/chart/shadow/
- * Shadow
- * @sample {highmaps} maps/chart/border/
- * Chart border and shadow
- *
- * @type {boolean|Highcharts.CSSObject}
- * @default false
- * @apioption chart.shadow
- */
- /**
- * Whether to show the axes initially. This only applies to empty charts
- * where series are added dynamically, as axes are automatically added
- * to cartesian series.
- *
- * @sample {highcharts} highcharts/chart/showaxes-false/
- * False by default
- * @sample {highcharts} highcharts/chart/showaxes-true/
- * True
- *
- * @type {boolean}
- * @since 1.2.5
- * @product highcharts gantt
- * @apioption chart.showAxes
- */
- /**
- * The space between the bottom edge of the chart and the content (plot
- * area, axis title and labels, title, subtitle or legend in top
- * position).
- *
- * @sample {highcharts} highcharts/chart/spacingbottom/
- * Spacing bottom set to 100
- * @sample {highstock} stock/chart/spacingbottom/
- * Spacing bottom set to 100
- * @sample {highmaps} maps/chart/spacing/
- * Spacing 100 all around
- *
- * @type {number}
- * @default 15
- * @since 2.1
- * @apioption chart.spacingBottom
- */
- /**
- * The space between the left edge of the chart and the content (plot
- * area, axis title and labels, title, subtitle or legend in top
- * position).
- *
- * @sample {highcharts} highcharts/chart/spacingleft/
- * Spacing left set to 100
- * @sample {highstock} stock/chart/spacingleft/
- * Spacing left set to 100
- * @sample {highmaps} maps/chart/spacing/
- * Spacing 100 all around
- *
- * @type {number}
- * @default 10
- * @since 2.1
- * @apioption chart.spacingLeft
- */
- /**
- * The space between the right edge of the chart and the content (plot
- * area, axis title and labels, title, subtitle or legend in top
- * position).
- *
- * @sample {highcharts} highcharts/chart/spacingright-100/
- * Spacing set to 100
- * @sample {highcharts} highcharts/chart/spacingright-legend/
- * Legend in right position with default spacing
- * @sample {highstock} stock/chart/spacingright/
- * Spacing set to 100
- * @sample {highmaps} maps/chart/spacing/
- * Spacing 100 all around
- *
- * @type {number}
- * @default 10
- * @since 2.1
- * @apioption chart.spacingRight
- */
- /**
- * The space between the top edge of the chart and the content (plot
- * area, axis title and labels, title, subtitle or legend in top
- * position).
- *
- * @sample {highcharts} highcharts/chart/spacingtop-100/
- * A top spacing of 100
- * @sample {highcharts} highcharts/chart/spacingtop-10/
- * Floating chart title makes the plot area align to the default
- * spacingTop of 10.
- * @sample {highstock} stock/chart/spacingtop/
- * A top spacing of 100
- * @sample {highmaps} maps/chart/spacing/
- * Spacing 100 all around
- *
- * @type {number}
- * @default 10
- * @since 2.1
- * @apioption chart.spacingTop
- */
- /**
- * Additional CSS styles to apply inline to the container `div`. Note
- * that since the default font styles are applied in the renderer, it
- * is ignorant of the individual chart options and must be set globally.
- *
- * @see In styled mode, general chart styles can be set with the
- * `.highcharts-root` class.
- * @sample {highcharts} highcharts/chart/style-serif-font/
- * Using a serif type font
- * @sample {highcharts} highcharts/css/em/
- * Styled mode with relative font sizes
- * @sample {highstock} stock/chart/style/
- * Using a serif type font
- * @sample {highmaps} maps/chart/style-serif-font/
- * Using a serif type font
- *
- * @type {Highcharts.CSSObject}
- * @default {"fontFamily": "\"Lucida Grande\", \"Lucida Sans Unicode\", Verdana, Arial, Helvetica, sans-serif","fontSize":"12px"}
- * @apioption chart.style
- */
- /**
- * The default series type for the chart. Can be any of the chart types
- * listed under [plotOptions](#plotOptions) and [series](#series) or can
- * be a series provided by an additional module.
- *
- * In TypeScript this option has no effect in sense of typing and
- * instead the `type` option must always be set in the series.
- *
- * @sample {highcharts} highcharts/chart/type-bar/
- * Bar
- * @sample {highstock} stock/chart/type/
- * Areaspline
- * @sample {highmaps} maps/chart/type-mapline/
- * Mapline
- *
- * @type {string}
- * @default {highcharts} line
- * @default {highstock} line
- * @default {highmaps} map
- * @since 2.1.0
- * @apioption chart.type
- */
- /**
- * Decides in what dimensions the user can zoom by dragging the mouse.
- * Can be one of `x`, `y` or `xy`.
- *
- * @see [panKey](#chart.panKey)
- *
- * @sample {highcharts} highcharts/chart/zoomtype-none/
- * None by default
- * @sample {highcharts} highcharts/chart/zoomtype-x/
- * X
- * @sample {highcharts} highcharts/chart/zoomtype-y/
- * Y
- * @sample {highcharts} highcharts/chart/zoomtype-xy/
- * Xy
- * @sample {highstock} stock/demo/basic-line/
- * None by default
- * @sample {highstock} stock/chart/zoomtype-x/
- * X
- * @sample {highstock} stock/chart/zoomtype-y/
- * Y
- * @sample {highstock} stock/chart/zoomtype-xy/
- * Xy
- *
- * @type {string}
- * @product highcharts highstock gantt
- * @validvalue ["x", "y", "xy"]
- * @apioption chart.zoomType
- */
- /**
- * An explicit width for the chart. By default (when `null`) the width
- * is calculated from the offset width of the containing element.
- *
- * @sample {highcharts} highcharts/chart/width/
- * 800px wide
- * @sample {highstock} stock/chart/width/
- * 800px wide
- * @sample {highmaps} maps/chart/size/
- * Chart with explicit size
- *
- * @type {null|number|string}
- */
- width: null,
- /**
- * An explicit height for the chart. If a _number_, the height is
- * given in pixels. If given a _percentage string_ (for example
- * `'56%'`), the height is given as the percentage of the actual chart
- * width. This allows for preserving the aspect ratio across responsive
- * sizes.
- *
- * By default (when `null`) the height is calculated from the offset
- * height of the containing element, or 400 pixels if the containing
- * element's height is 0.
- *
- * @sample {highcharts} highcharts/chart/height/
- * 500px height
- * @sample {highstock} stock/chart/height/
- * 300px height
- * @sample {highmaps} maps/chart/size/
- * Chart with explicit size
- * @sample highcharts/chart/height-percent/
- * Highcharts with percentage height
- *
- * @type {null|number|string}
- */
- height: null,
- /**
- * The color of the outer chart border.
- *
- * @see In styled mode, the stroke is set with the
- * `.highcharts-background` class.
- *
- * @sample {highcharts} highcharts/chart/bordercolor/
- * Brown border
- * @sample {highstock} stock/chart/border/
- * Brown border
- * @sample {highmaps} maps/chart/border/
- * Border options
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- */
- borderColor: '#335cad',
- /**
- * The pixel width of the outer chart border.
- *
- * @see In styled mode, the stroke is set with the
- * `.highcharts-background` class.
- *
- * @sample {highcharts} highcharts/chart/borderwidth/
- * 5px border
- * @sample {highstock} stock/chart/border/
- * 2px border
- * @sample {highmaps} maps/chart/border/
- * Border options
- *
- * @type {number}
- * @default 0
- * @apioption chart.borderWidth
- */
- /**
- * The background color or gradient for the outer chart area.
- *
- * @see In styled mode, the background is set with the
- * `.highcharts-background` class.
- *
- * @sample {highcharts} highcharts/chart/backgroundcolor-color/
- * Color
- * @sample {highcharts} highcharts/chart/backgroundcolor-gradient/
- * Gradient
- * @sample {highstock} stock/chart/backgroundcolor-color/
- * Color
- * @sample {highstock} stock/chart/backgroundcolor-gradient/
- * Gradient
- * @sample {highmaps} maps/chart/backgroundcolor-color/
- * Color
- * @sample {highmaps} maps/chart/backgroundcolor-gradient/
- * Gradient
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- */
- backgroundColor: '#ffffff',
- /**
- * The background color or gradient for the plot area.
- *
- * @see In styled mode, the plot background is set with the
- * `.highcharts-plot-background` class.
- *
- * @sample {highcharts} highcharts/chart/plotbackgroundcolor-color/
- * Color
- * @sample {highcharts} highcharts/chart/plotbackgroundcolor-gradient/
- * Gradient
- * @sample {highstock} stock/chart/plotbackgroundcolor-color/
- * Color
- * @sample {highstock} stock/chart/plotbackgroundcolor-gradient/
- * Gradient
- * @sample {highmaps} maps/chart/plotbackgroundcolor-color/
- * Color
- * @sample {highmaps} maps/chart/plotbackgroundcolor-gradient/
- * Gradient
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- * @apioption chart.plotBackgroundColor
- */
- /**
- * The URL for an image to use as the plot background. To set an image
- * as the background for the entire chart, set a CSS background image
- * to the container element. Note that for the image to be applied to
- * exported charts, its URL needs to be accessible by the export server.
- *
- * @see In styled mode, a plot background image can be set with the
- * `.highcharts-plot-background` class and a [custom pattern](
- * https://www.highcharts.com/docs/chart-design-and-style/
- * gradients-shadows-and-patterns).
- *
- * @sample {highcharts} highcharts/chart/plotbackgroundimage/
- * Skies
- * @sample {highstock} stock/chart/plotbackgroundimage/
- * Skies
- *
- * @type {string}
- * @apioption chart.plotBackgroundImage
- */
- /**
- * The color of the inner chart or plot area border.
- *
- * @see In styled mode, a plot border stroke can be set with the
- * `.highcharts-plot-border` class.
- *
- * @sample {highcharts} highcharts/chart/plotbordercolor/
- * Blue border
- * @sample {highstock} stock/chart/plotborder/
- * Blue border
- * @sample {highmaps} maps/chart/plotborder/
- * Plot border options
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- */
- plotBorderColor: '#cccccc'
- },
- /**
- * The chart's main title.
- *
- * @sample {highmaps} maps/title/title/
- * Title options demonstrated
- */
- title: {
- /**
- * When the title is floating, the plot area will not move to make space
- * for it.
- *
- * @sample {highcharts} highcharts/chart/zoomtype-none/
- * False by default
- * @sample {highcharts} highcharts/title/floating/
- * True - title on top of the plot area
- * @sample {highstock} stock/chart/title-floating/
- * True - title on top of the plot area
- *
- * @type {boolean}
- * @default false
- * @since 2.1
- * @apioption title.floating
- */
- /**
- * CSS styles for the title. Use this for font styling, but use `align`,
- * `x` and `y` for text alignment.
- *
- * In styled mode, the title style is given in the `.highcharts-title`
- * class.
- *
- * @sample {highcharts} highcharts/title/style/
- * Custom color and weight
- * @sample {highstock} stock/chart/title-style/
- * Custom color and weight
- * @sample highcharts/css/titles/
- * Styled mode
- *
- * @type {Highcharts.CSSObject}
- * @default {highcharts|highmaps} { "color": "#333333", "fontSize": "18px" }
- * @default {highstock} { "color": "#333333", "fontSize": "16px" }
- * @apioption title.style
- */
- /**
- * Whether to
- * [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
- * to render the text.
- *
- * @type {boolean}
- * @default false
- * @apioption title.useHTML
- */
- /**
- * The vertical alignment of the title. Can be one of `"top"`,
- * `"middle"` and `"bottom"`. When a value is given, the title behaves
- * as if [floating](#title.floating) were `true`.
- *
- * @sample {highcharts} highcharts/title/verticalalign/
- * Chart title in bottom right corner
- * @sample {highstock} stock/chart/title-verticalalign/
- * Chart title in bottom right corner
- *
- * @type {Highcharts.VerticalAlignValue}
- * @since 2.1
- * @apioption title.verticalAlign
- */
- /**
- * The x position of the title relative to the alignment within
- * `chart.spacingLeft` and `chart.spacingRight`.
- *
- * @sample {highcharts} highcharts/title/align/
- * Aligned to the plot area (x = 70px = margin left - spacing
- * left)
- * @sample {highstock} stock/chart/title-align/
- * Aligned to the plot area (x = 50px = margin left - spacing
- * left)
- *
- * @type {number}
- * @default 0
- * @since 2.0
- * @apioption title.x
- */
- /**
- * The y position of the title relative to the alignment within
- * [chart.spacingTop](#chart.spacingTop) and [chart.spacingBottom](
- * #chart.spacingBottom). By default it depends on the font size.
- *
- * @sample {highcharts} highcharts/title/y/
- * Title inside the plot area
- * @sample {highstock} stock/chart/title-verticalalign/
- * Chart title in bottom right corner
- *
- * @type {number}
- * @since 2.0
- * @apioption title.y
- */
- /**
- * The title of the chart. To disable the title, set the `text` to
- * `undefined`.
- *
- * @sample {highcharts} highcharts/title/text/
- * Custom title
- * @sample {highstock} stock/chart/title-text/
- * Custom title
- *
- * @default {highcharts|highmaps} Chart title
- * @default {highstock} undefined
- */
- text: 'Chart title',
- /**
- * The horizontal alignment of the title. Can be one of "left", "center"
- * and "right".
- *
- * @sample {highcharts} highcharts/title/align/
- * Aligned to the plot area (x = 70px = margin left - spacing
- * left)
- * @sample {highstock} stock/chart/title-align/
- * Aligned to the plot area (x = 50px = margin left - spacing
- * left)
- *
- * @type {Highcharts.AlignValue}
- * @since 2.0
- */
- align: 'center',
- /**
- * The margin between the title and the plot area, or if a subtitle
- * is present, the margin between the subtitle and the plot area.
- *
- * @sample {highcharts} highcharts/title/margin-50/
- * A chart title margin of 50
- * @sample {highcharts} highcharts/title/margin-subtitle/
- * The same margin applied with a subtitle
- * @sample {highstock} stock/chart/title-margin/
- * A chart title margin of 50
- *
- * @since 2.1
- */
- margin: 15,
- /**
- * Adjustment made to the title width, normally to reserve space for
- * the exporting burger menu.
- *
- * @sample highcharts/title/widthadjust/
- * Wider menu, greater padding
- *
- * @since 4.2.5
- */
- widthAdjust: -44
- },
- /**
- * The chart's subtitle. This can be used both to display a subtitle below
- * the main title, and to display random text anywhere in the chart. The
- * subtitle can be updated after chart initialization through the
- * `Chart.setTitle` method.
- *
- * @sample {highmaps} maps/title/subtitle/
- * Subtitle options demonstrated
- */
- subtitle: {
- /**
- * When the subtitle is floating, the plot area will not move to make
- * space for it.
- *
- * @sample {highcharts} highcharts/subtitle/floating/
- * Floating title and subtitle
- * @sample {highstock} stock/chart/subtitle-footnote
- * Footnote floating at bottom right of plot area
- *
- * @type {boolean}
- * @default false
- * @since 2.1
- * @apioption subtitle.floating
- */
- /**
- * CSS styles for the title.
- *
- * In styled mode, the subtitle style is given in the
- * `.highcharts-subtitle` class.
- *
- * @sample {highcharts} highcharts/subtitle/style/
- * Custom color and weight
- * @sample {highcharts} highcharts/css/titles/
- * Styled mode
- * @sample {highstock} stock/chart/subtitle-style
- * Custom color and weight
- * @sample {highstock} highcharts/css/titles/
- * Styled mode
- * @sample {highmaps} highcharts/css/titles/
- * Styled mode
- *
- * @type {Highcharts.CSSObject}
- * @default {"color": "#666666"}
- * @apioption subtitle.style
- */
- /**
- * Whether to
- * [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
- * to render the text.
- *
- * @type {boolean}
- * @default false
- * @apioption subtitle.useHTML
- */
- /**
- * The vertical alignment of the title. Can be one of `"top"`,
- * `"middle"` and `"bottom"`. When middle, the subtitle behaves as
- * floating.
- *
- * @sample {highcharts} highcharts/subtitle/verticalalign/
- * Footnote at the bottom right of plot area
- * @sample {highstock} stock/chart/subtitle-footnote
- * Footnote at the bottom right of plot area
- *
- * @type {Highcharts.VerticalAlignValue}
- * @since 2.1
- * @apioption subtitle.verticalAlign
- */
- /**
- * The x position of the subtitle relative to the alignment within
- * `chart.spacingLeft` and `chart.spacingRight`.
- *
- * @sample {highcharts} highcharts/subtitle/align/
- * Footnote at right of plot area
- * @sample {highstock} stock/chart/subtitle-footnote
- * Footnote at the bottom right of plot area
- *
- * @type {number}
- * @default 0
- * @since 2.0
- * @apioption subtitle.x
- */
- /**
- * The y position of the subtitle relative to the alignment within
- * `chart.spacingTop` and `chart.spacingBottom`. By default the subtitle
- * is laid out below the title unless the title is floating.
- *
- * @sample {highcharts} highcharts/subtitle/verticalalign/
- * Footnote at the bottom right of plot area
- * @sample {highstock} stock/chart/subtitle-footnote
- * Footnote at the bottom right of plot area
- *
- * @type {number}
- * @since 2.0
- * @apioption subtitle.y
- */
- /**
- * The subtitle of the chart.
- *
- * @sample {highcharts|highstock} highcharts/subtitle/text/
- * Custom subtitle
- * @sample {highcharts|highstock} highcharts/subtitle/text-formatted/
- * Formatted and linked text.
- */
- text: '',
- /**
- * The horizontal alignment of the subtitle. Can be one of "left",
- * "center" and "right".
- *
- * @sample {highcharts} highcharts/subtitle/align/
- * Footnote at right of plot area
- * @sample {highstock} stock/chart/subtitle-footnote
- * Footnote at bottom right of plot area
- *
- * @type {Highcharts.AlignValue}
- * @since 2.0
- */
- align: 'center',
- /**
- * Adjustment made to the subtitle width, normally to reserve space
- * for the exporting burger menu.
- *
- * @see [title.widthAdjust](#title.widthAdjust)
- *
- * @sample highcharts/title/widthadjust/
- * Wider menu, greater padding
- *
- * @since 4.2.5
- */
- widthAdjust: -44
- },
- /**
- * The chart's caption, which will render below the chart and will be part
- * of exported charts. The caption can be updated after chart initialization
- * through the `Chart.update` or `Chart.caption.update` methods.
- *
- * @sample highcharts/caption/text/
- * A chart with a caption
- * @since 7.2.0
- */
- caption: {
- /**
- * When the caption is floating, the plot area will not move to make
- * space for it.
- *
- * @type {boolean}
- * @default false
- * @apioption caption.floating
- */
- /**
- * The margin between the caption and the plot area.
- */
- margin: 15,
- /**
- * CSS styles for the caption.
- *
- * In styled mode, the caption style is given in the
- * `.highcharts-caption` class.
- *
- * @sample {highcharts} highcharts/css/titles/
- * Styled mode
- *
- * @type {Highcharts.CSSObject}
- * @default {"color": "#666666"}
- * @apioption caption.style
- */
- /**
- * Whether to
- * [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
- * to render the text.
- *
- * @type {boolean}
- * @default false
- * @apioption caption.useHTML
- */
- /**
- * The x position of the caption relative to the alignment within
- * `chart.spacingLeft` and `chart.spacingRight`.
- *
- * @type {number}
- * @default 0
- * @apioption caption.x
- */
- /**
- * The y position of the caption relative to the alignment within
- * `chart.spacingTop` and `chart.spacingBottom`.
- *
- * @type {number}
- * @apioption caption.y
- */
- /**
- * The caption text of the chart.
- *
- * @sample {highcharts} highcharts/caption/text/
- * Custom caption
- */
- text: '',
- /**
- * The horizontal alignment of the caption. Can be one of "left",
- * "center" and "right".
- *
- * @type {Highcharts.AlignValue}
- */
- align: 'left',
- /**
- * The vertical alignment of the caption. Can be one of `"top"`,
- * `"middle"` and `"bottom"`. When middle, the caption behaves as
- * floating.
- *
- * @type {Highcharts.VerticalAlignValue}
- */
- verticalAlign: 'bottom'
- },
- /**
- * The plotOptions is a wrapper object for config objects for each series
- * type. The config objects for each series can also be overridden for
- * each series item as given in the series array.
- *
- * Configuration options for the series are given in three levels. Options
- * for all series in a chart are given in the [plotOptions.series](
- * #plotOptions.series) object. Then options for all series of a specific
- * type are given in the plotOptions of that type, for example
- * `plotOptions.line`. Next, options for one single series are given in
- * [the series array](#series).
- */
- plotOptions: {},
- /**
- * HTML labels that can be positioned anywhere in the chart area.
- *
- * This option is deprecated since v7.1.2. Instead, use
- * [annotations](#annotations) that support labels.
- *
- * @deprecated
- * @product highcharts highstock
- */
- labels: {
- /**
- * An HTML label that can be positioned anywhere in the chart area.
- *
- * @deprecated
- * @type {Array<*>}
- * @apioption labels.items
- */
- /**
- * Inner HTML or text for the label.
- *
- * @deprecated
- * @type {string}
- * @apioption labels.items.html
- */
- /**
- * CSS styles for each label. To position the label, use left and top
- * like this:
- * ```js
- * style: {
- * left: '100px',
- * top: '100px'
- * }
- * ```
- *
- * @deprecated
- * @type {Highcharts.CSSObject}
- * @apioption labels.items.style
- */
- /**
- * Shared CSS styles for all labels.
- *
- * @deprecated
- * @type {Highcharts.CSSObject}
- * @default {"color": "#333333", "position": "absolute"}
- */
- style: {
- /**
- * @ignore-option
- */
- position: 'absolute',
- /**
- * @ignore-option
- */
- color: '#333333'
- }
- },
- /**
- * The legend is a box containing a symbol and name for each series
- * item or point item in the chart. Each series (or points in case
- * of pie charts) is represented by a symbol and its name in the legend.
- *
- * It is possible to override the symbol creator function and create
- * [custom legend symbols](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/studies/legend-custom-symbol/).
- *
- * @productdesc {highmaps}
- * A Highmaps legend by default contains one legend item per series, but if
- * a `colorAxis` is defined, the axis will be displayed in the legend.
- * Either as a gradient, or as multiple legend items for `dataClasses`.
- */
- legend: {
- /**
- * The background color of the legend.
- *
- * @see In styled mode, the legend background fill can be applied with
- * the `.highcharts-legend-box` class.
- *
- * @sample {highcharts} highcharts/legend/backgroundcolor/
- * Yellowish background
- * @sample {highstock} stock/legend/align/
- * Various legend options
- * @sample {highmaps} maps/legend/border-background/
- * Border and background options
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- * @apioption legend.backgroundColor
- */
- /**
- * The width of the drawn border around the legend.
- *
- * @see In styled mode, the legend border stroke width can be applied
- * with the `.highcharts-legend-box` class.
- *
- * @sample {highcharts} highcharts/legend/borderwidth/
- * 2px border width
- * @sample {highstock} stock/legend/align/
- * Various legend options
- * @sample {highmaps} maps/legend/border-background/
- * Border and background options
- *
- * @type {number}
- * @default 0
- * @apioption legend.borderWidth
- */
- /**
- * Enable or disable the legend. There is also a series-specific option,
- * [showInLegend](#plotOptions.series.showInLegend), that can hide the
- * series from the legend. In some series types this is `false` by
- * default, so it must set to `true` in order to show the legend for the
- * series.
- *
- * @sample {highcharts} highcharts/legend/enabled-false/ Legend disabled
- * @sample {highstock} stock/legend/align/ Various legend options
- * @sample {highmaps} maps/legend/enabled-false/ Legend disabled
- *
- * @default {highstock} false
- * @default {highmaps} true
- * @default {gantt} false
- */
- enabled: true,
- /**
- * The horizontal alignment of the legend box within the chart area.
- * Valid values are `left`, `center` and `right`.
- *
- * In the case that the legend is aligned in a corner position, the
- * `layout` option will determine whether to place it above/below
- * or on the side of the plot area.
- *
- * @sample {highcharts} highcharts/legend/align/
- * Legend at the right of the chart
- * @sample {highstock} stock/legend/align/
- * Various legend options
- * @sample {highmaps} maps/legend/alignment/
- * Legend alignment
- *
- * @type {Highcharts.AlignValue}
- * @since 2.0
- */
- align: 'center',
- /**
- * If the [layout](legend.layout) is `horizontal` and the legend items
- * span over two lines or more, whether to align the items into vertical
- * columns. Setting this to `false` makes room for more items, but will
- * look more messy.
- *
- * @since 6.1.0
- */
- alignColumns: true,
- /**
- * When the legend is floating, the plot area ignores it and is allowed
- * to be placed below it.
- *
- * @sample {highcharts} highcharts/legend/floating-false/
- * False by default
- * @sample {highcharts} highcharts/legend/floating-true/
- * True
- * @sample {highmaps} maps/legend/alignment/
- * Floating legend
- *
- * @type {boolean}
- * @default false
- * @since 2.1
- * @apioption legend.floating
- */
- /**
- * The layout of the legend items. Can be one of `horizontal` or
- * `vertical` or `proximate`. When `proximate`, the legend items will be
- * placed as close as possible to the graphs they're representing,
- * except in inverted charts or when the legend position doesn't allow
- * it.
- *
- * @sample {highcharts} highcharts/legend/layout-horizontal/
- * Horizontal by default
- * @sample {highcharts} highcharts/legend/layout-vertical/
- * Vertical
- * @sample highcharts/legend/layout-proximate
- * Labels proximate to the data
- * @sample {highstock} stock/legend/layout-horizontal/
- * Horizontal by default
- * @sample {highmaps} maps/legend/padding-itemmargin/
- * Vertical with data classes
- * @sample {highmaps} maps/legend/layout-vertical/
- * Vertical with color axis gradient
- *
- * @validvalue ["horizontal", "vertical", "proximate"]
- */
- layout: 'horizontal',
- /**
- * In a legend with horizontal layout, the itemDistance defines the
- * pixel distance between each item.
- *
- * @sample {highcharts} highcharts/legend/layout-horizontal/
- * 50px item distance
- * @sample {highstock} highcharts/legend/layout-horizontal/
- * 50px item distance
- *
- * @type {number}
- * @default {highcharts} 20
- * @default {highstock} 20
- * @default {highmaps} 8
- * @since 3.0.3
- * @apioption legend.itemDistance
- */
- /**
- * The pixel bottom margin for each legend item.
- *
- * @sample {highcharts|highstock} highcharts/legend/padding-itemmargin/
- * Padding and item margins demonstrated
- * @sample {highmaps} maps/legend/padding-itemmargin/
- * Padding and item margins demonstrated
- *
- * @type {number}
- * @default 0
- * @since 2.2.0
- * @apioption legend.itemMarginBottom
- */
- /**
- * The pixel top margin for each legend item.
- *
- * @sample {highcharts|highstock} highcharts/legend/padding-itemmargin/
- * Padding and item margins demonstrated
- * @sample {highmaps} maps/legend/padding-itemmargin/
- * Padding and item margins demonstrated
- *
- * @type {number}
- * @default 0
- * @since 2.2.0
- * @apioption legend.itemMarginTop
- */
- /**
- * The width for each legend item. By default the items are laid out
- * successively. In a [horizontal layout](legend.layout), if the items
- * are laid out across two rows or more, they will be vertically aligned
- * depending on the [legend.alignColumns](legend.alignColumns) option.
- *
- * @sample {highcharts} highcharts/legend/itemwidth-default/
- * Undefined by default
- * @sample {highcharts} highcharts/legend/itemwidth-80/
- * 80 for aligned legend items
- *
- * @type {number}
- * @since 2.0
- * @apioption legend.itemWidth
- */
- /**
- * A [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
- * for each legend label. Available variables relates to properties on
- * the series, or the point in case of pies.
- *
- * @type {string}
- * @default {name}
- * @since 1.3
- * @apioption legend.labelFormat
- */
- /* eslint-disable valid-jsdoc */
- /**
- * Callback function to format each of the series' labels. The `this`
- * keyword refers to the series object, or the point object in case of
- * pie charts. By default the series or point name is printed.
- *
- * @productdesc {highmaps}
- * In Highmaps the context can also be a data class in case of a
- * `colorAxis`.
- *
- * @sample {highcharts} highcharts/legend/labelformatter/
- * Add text
- * @sample {highmaps} maps/legend/labelformatter/
- * Data classes with label formatter
- *
- * @type {Highcharts.FormatterCallbackFunction<Point|Series>}
- */
- labelFormatter: function () {
- /** eslint-enable valid-jsdoc */
- return this.name;
- },
- /**
- * Line height for the legend items. Deprecated as of 2.1\. Instead,
- * the line height for each item can be set using
- * `itemStyle.lineHeight`, and the padding between items using
- * `itemMarginTop` and `itemMarginBottom`.
- *
- * @sample {highcharts} highcharts/legend/lineheight/
- * Setting padding
- *
- * @deprecated
- *
- * @type {number}
- * @default 16
- * @since 2.0
- * @product highcharts gantt
- * @apioption legend.lineHeight
- */
- /**
- * If the plot area sized is calculated automatically and the legend is
- * not floating, the legend margin is the space between the legend and
- * the axis labels or plot area.
- *
- * @sample {highcharts} highcharts/legend/margin-default/
- * 12 pixels by default
- * @sample {highcharts} highcharts/legend/margin-30/
- * 30 pixels
- *
- * @type {number}
- * @default 12
- * @since 2.1
- * @apioption legend.margin
- */
- /**
- * Maximum pixel height for the legend. When the maximum height is
- * extended, navigation will show.
- *
- * @type {number}
- * @since 2.3.0
- * @apioption legend.maxHeight
- */
- /**
- * The color of the drawn border around the legend.
- *
- * @see In styled mode, the legend border stroke can be applied with the
- * `.highcharts-legend-box` class.
- *
- * @sample {highcharts} highcharts/legend/bordercolor/
- * Brown border
- * @sample {highstock} stock/legend/align/
- * Various legend options
- * @sample {highmaps} maps/legend/border-background/
- * Border and background options
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- */
- borderColor: '#999999',
- /**
- * The border corner radius of the legend.
- *
- * @sample {highcharts} highcharts/legend/borderradius-default/
- * Square by default
- * @sample {highcharts} highcharts/legend/borderradius-round/
- * 5px rounded
- * @sample {highmaps} maps/legend/border-background/
- * Border and background options
- */
- borderRadius: 0,
- /**
- * Options for the paging or navigation appearing when the legend is
- * overflown. Navigation works well on screen, but not in static
- * exported images. One way of working around that is to
- * [increase the chart height in
- * export](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/legend/navigation-enabled-false/).
- */
- navigation: {
- /**
- * How to animate the pages when navigating up or down. A value of
- * `true` applies the default navigation given in the
- * `chart.animation` option. Additional options can be given as an
- * object containing values for easing and duration.
- *
- * @sample {highcharts} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- * @sample {highstock} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- *
- * @type {boolean|Partial<Highcharts.AnimationOptionsObject>}
- * @default true
- * @since 2.2.4
- * @apioption legend.navigation.animation
- */
- /**
- * The pixel size of the up and down arrows in the legend paging
- * navigation.
- *
- * @sample {highcharts} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- * @sample {highstock} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- *
- * @type {number}
- * @default 12
- * @since 2.2.4
- * @apioption legend.navigation.arrowSize
- */
- /**
- * Whether to enable the legend navigation. In most cases, disabling
- * the navigation results in an unwanted overflow.
- *
- * See also the [adapt chart to legend](
- * https://www.highcharts.com/products/plugin-registry/single/8/Adapt-Chart-To-Legend)
- * plugin for a solution to extend the chart height to make room for
- * the legend, optionally in exported charts only.
- *
- * @type {boolean}
- * @default true
- * @since 4.2.4
- * @apioption legend.navigation.enabled
- */
- /**
- * Text styles for the legend page navigation.
- *
- * @see In styled mode, the navigation items are styled with the
- * `.highcharts-legend-navigation` class.
- *
- * @sample {highcharts} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- * @sample {highstock} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- *
- * @type {Highcharts.CSSObject}
- * @since 2.2.4
- * @apioption legend.navigation.style
- */
- /**
- * The color for the active up or down arrow in the legend page
- * navigation.
- *
- * @see In styled mode, the active arrow be styled with the
- * `.highcharts-legend-nav-active` class.
- *
- * @sample {highcharts} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- * @sample {highstock} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- * @since 2.2.4
- */
- activeColor: '#003399',
- /**
- * The color of the inactive up or down arrow in the legend page
- * navigation. .
- *
- * @see In styled mode, the inactive arrow be styled with the
- * `.highcharts-legend-nav-inactive` class.
- *
- * @sample {highcharts} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- * @sample {highstock} highcharts/legend/navigation/
- * Legend page navigation demonstrated
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- * @since 2.2.4
- */
- inactiveColor: '#cccccc'
- },
- /**
- * The inner padding of the legend box.
- *
- * @sample {highcharts|highstock} highcharts/legend/padding-itemmargin/
- * Padding and item margins demonstrated
- * @sample {highmaps} maps/legend/padding-itemmargin/
- * Padding and item margins demonstrated
- *
- * @type {number}
- * @default 8
- * @since 2.2.0
- * @apioption legend.padding
- */
- /**
- * Whether to reverse the order of the legend items compared to the
- * order of the series or points as defined in the configuration object.
- *
- * @see [yAxis.reversedStacks](#yAxis.reversedStacks),
- * [series.legendIndex](#series.legendIndex)
- *
- * @sample {highcharts} highcharts/legend/reversed/
- * Stacked bar with reversed legend
- *
- * @type {boolean}
- * @default false
- * @since 1.2.5
- * @apioption legend.reversed
- */
- /**
- * Whether to show the symbol on the right side of the text rather than
- * the left side. This is common in Arabic and Hebraic.
- *
- * @sample {highcharts} highcharts/legend/rtl/
- * Symbol to the right
- *
- * @type {boolean}
- * @default false
- * @since 2.2
- * @apioption legend.rtl
- */
- /**
- * CSS styles for the legend area. In the 1.x versions the position
- * of the legend area was determined by CSS. In 2.x, the position is
- * determined by properties like `align`, `verticalAlign`, `x` and `y`,
- * but the styles are still parsed for backwards compatibility.
- *
- * @deprecated
- *
- * @type {Highcharts.CSSObject}
- * @product highcharts highstock
- * @apioption legend.style
- */
- /**
- * CSS styles for each legend item. Only a subset of CSS is supported,
- * notably those options related to text. The default `textOverflow`
- * property makes long texts truncate. Set it to `undefined` to wrap
- * text instead. A `width` property can be added to control the text
- * width.
- *
- * @see In styled mode, the legend items can be styled with the
- * `.highcharts-legend-item` class.
- *
- * @sample {highcharts} highcharts/legend/itemstyle/
- * Bold black text
- * @sample {highmaps} maps/legend/itemstyle/
- * Item text styles
- *
- * @type {Highcharts.CSSObject}
- * @default {"color": "#333333", "cursor": "pointer", "fontSize": "12px", "fontWeight": "bold", "textOverflow": "ellipsis"}
- */
- itemStyle: {
- /**
- * @ignore
- */
- color: '#333333',
- /**
- * @ignore
- */
- cursor: 'pointer',
- /**
- * @ignore
- */
- fontSize: '12px',
- /**
- * @ignore
- */
- fontWeight: 'bold',
- /**
- * @ignore
- */
- textOverflow: 'ellipsis'
- },
- /**
- * CSS styles for each legend item in hover mode. Only a subset of
- * CSS is supported, notably those options related to text. Properties
- * are inherited from `style` unless overridden here.
- *
- * @see In styled mode, the hovered legend items can be styled with
- * the `.highcharts-legend-item:hover` pesudo-class.
- *
- * @sample {highcharts} highcharts/legend/itemhoverstyle/
- * Red on hover
- * @sample {highmaps} maps/legend/itemstyle/
- * Item text styles
- *
- * @type {Highcharts.CSSObject}
- * @default {"color": "#000000"}
- */
- itemHoverStyle: {
- /**
- * @ignore
- */
- color: '#000000'
- },
- /**
- * CSS styles for each legend item when the corresponding series or
- * point is hidden. Only a subset of CSS is supported, notably those
- * options related to text. Properties are inherited from `style`
- * unless overridden here.
- *
- * @see In styled mode, the hidden legend items can be styled with
- * the `.highcharts-legend-item-hidden` class.
- *
- * @sample {highcharts} highcharts/legend/itemhiddenstyle/
- * Darker gray color
- *
- * @type {Highcharts.CSSObject}
- * @default {"color": "#cccccc"}
- */
- itemHiddenStyle: {
- /**
- * @ignore
- */
- color: '#cccccc'
- },
- /**
- * Whether to apply a drop shadow to the legend. A `backgroundColor`
- * also needs to be applied for this to take effect. The shadow can be
- * an object configuration containing `color`, `offsetX`, `offsetY`,
- * `opacity` and `width`.
- *
- * @sample {highcharts} highcharts/legend/shadow/
- * White background and drop shadow
- * @sample {highstock} stock/legend/align/
- * Various legend options
- * @sample {highmaps} maps/legend/border-background/
- * Border and background options
- *
- * @type {boolean|Highcharts.CSSObject}
- */
- shadow: false,
- /**
- * Default styling for the checkbox next to a legend item when
- * `showCheckbox` is true.
- *
- * @type {Highcharts.CSSObject}
- * @default {"width": "13px", "height": "13px", "position":"absolute"}
- */
- itemCheckboxStyle: {
- /**
- * @ignore
- */
- position: 'absolute',
- /**
- * @ignore
- */
- width: '13px',
- /**
- * @ignore
- */
- height: '13px'
- },
- // itemWidth: undefined,
- /**
- * When this is true, the legend symbol width will be the same as
- * the symbol height, which in turn defaults to the font size of the
- * legend items.
- *
- * @since 5.0.0
- */
- squareSymbol: true,
- /**
- * The pixel height of the symbol for series types that use a rectangle
- * in the legend. Defaults to the font size of legend items.
- *
- * @productdesc {highmaps}
- * In Highmaps, when the symbol is the gradient of a vertical color
- * axis, the height defaults to 200.
- *
- * @sample {highmaps} maps/legend/layout-vertical-sized/
- * Sized vertical gradient
- * @sample {highmaps} maps/legend/padding-itemmargin/
- * No distance between data classes
- *
- * @type {number}
- * @since 3.0.8
- * @apioption legend.symbolHeight
- */
- /**
- * The border radius of the symbol for series types that use a rectangle
- * in the legend. Defaults to half the `symbolHeight`.
- *
- * @sample {highcharts} highcharts/legend/symbolradius/
- * Round symbols
- * @sample {highstock} highcharts/legend/symbolradius/
- * Round symbols
- * @sample {highmaps} highcharts/legend/symbolradius/
- * Round symbols
- *
- * @type {number}
- * @since 3.0.8
- * @apioption legend.symbolRadius
- */
- /**
- * The pixel width of the legend item symbol. When the `squareSymbol`
- * option is set, this defaults to the `symbolHeight`, otherwise 16.
- *
- * @productdesc {highmaps}
- * In Highmaps, when the symbol is the gradient of a horizontal color
- * axis, the width defaults to 200.
- *
- * @sample {highcharts} highcharts/legend/symbolwidth/
- * Greater symbol width and padding
- * @sample {highmaps} maps/legend/padding-itemmargin/
- * Padding and item margins demonstrated
- * @sample {highmaps} maps/legend/layout-vertical-sized/
- * Sized vertical gradient
- *
- * @type {number}
- * @apioption legend.symbolWidth
- */
- /**
- * Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
- * to render the legend item texts.
- *
- * Prior to 4.1.7, when using HTML, [legend.navigation](
- * #legend.navigation) was disabled.
- *
- * @type {boolean}
- * @default false
- * @apioption legend.useHTML
- */
- /**
- * The width of the legend box. If a number is set, it translates to
- * pixels. Since v7.0.2 it allows setting a percent string of the full
- * chart width, for example `40%`.
- *
- * Defaults to the full chart width for legends below or above the
- * chart, half the chart width for legends to the left and right.
- *
- * @sample {highcharts} highcharts/legend/width/
- * Aligned to the plot area
- * @sample {highcharts} highcharts/legend/width-percent/
- * A percent of the chart width
- *
- * @type {number|string}
- * @since 2.0
- * @apioption legend.width
- */
- /**
- * The pixel padding between the legend item symbol and the legend
- * item text.
- *
- * @sample {highcharts} highcharts/legend/symbolpadding/
- * Greater symbol width and padding
- */
- symbolPadding: 5,
- /**
- * The vertical alignment of the legend box. Can be one of `top`,
- * `middle` or `bottom`. Vertical position can be further determined
- * by the `y` option.
- *
- * In the case that the legend is aligned in a corner position, the
- * `layout` option will determine whether to place it above/below
- * or on the side of the plot area.
- *
- * When the [layout](#legend.layout) option is `proximate`, the
- * `verticalAlign` option doesn't apply.
- *
- * @sample {highcharts} highcharts/legend/verticalalign/
- * Legend 100px from the top of the chart
- * @sample {highstock} stock/legend/align/
- * Various legend options
- * @sample {highmaps} maps/legend/alignment/
- * Legend alignment
- *
- * @type {Highcharts.VerticalAlignValue}
- * @since 2.0
- */
- verticalAlign: 'bottom',
- // width: undefined,
- /**
- * The x offset of the legend relative to its horizontal alignment
- * `align` within chart.spacingLeft and chart.spacingRight. Negative
- * x moves it to the left, positive x moves it to the right.
- *
- * @sample {highcharts} highcharts/legend/width/
- * Aligned to the plot area
- *
- * @since 2.0
- */
- x: 0,
- /**
- * The vertical offset of the legend relative to it's vertical alignment
- * `verticalAlign` within chart.spacingTop and chart.spacingBottom.
- * Negative y moves it up, positive y moves it down.
- *
- * @sample {highcharts} highcharts/legend/verticalalign/
- * Legend 100px from the top of the chart
- * @sample {highstock} stock/legend/align/
- * Various legend options
- * @sample {highmaps} maps/legend/alignment/
- * Legend alignment
- *
- * @since 2.0
- */
- y: 0,
- /**
- * A title to be added on top of the legend.
- *
- * @sample {highcharts} highcharts/legend/title/
- * Legend title
- * @sample {highmaps} maps/legend/alignment/
- * Legend with title
- *
- * @since 3.0
- */
- title: {
- /**
- * A text or HTML string for the title.
- *
- * @type {string}
- * @since 3.0
- * @apioption legend.title.text
- */
- /**
- * Generic CSS styles for the legend title.
- *
- * @see In styled mode, the legend title is styled with the
- * `.highcharts-legend-title` class.
- *
- * @type {Highcharts.CSSObject}
- * @default {"fontWeight": "bold"}
- * @since 3.0
- */
- style: {
- /**
- * @ignore
- */
- fontWeight: 'bold'
- }
- }
- },
- /**
- * The loading options control the appearance of the loading screen
- * that covers the plot area on chart operations. This screen only
- * appears after an explicit call to `chart.showLoading()`. It is a
- * utility for developers to communicate to the end user that something
- * is going on, for example while retrieving new data via an XHR connection.
- * The "Loading..." text itself is not part of this configuration
- * object, but part of the `lang` object.
- */
- loading: {
- /**
- * The duration in milliseconds of the fade out effect.
- *
- * @sample highcharts/loading/hideduration/
- * Fade in and out over a second
- *
- * @type {number}
- * @default 100
- * @since 1.2.0
- * @apioption loading.hideDuration
- */
- /**
- * The duration in milliseconds of the fade in effect.
- *
- * @sample highcharts/loading/hideduration/
- * Fade in and out over a second
- *
- * @type {number}
- * @default 100
- * @since 1.2.0
- * @apioption loading.showDuration
- */
- /**
- * CSS styles for the loading label `span`.
- *
- * @see In styled mode, the loading label is styled with the
- * `.highcharts-loading-inner` class.
- *
- * @sample {highcharts|highmaps} highcharts/loading/labelstyle/
- * Vertically centered
- * @sample {highstock} stock/loading/general/
- * Label styles
- *
- * @type {Highcharts.CSSObject}
- * @default {"fontWeight": "bold", "position": "relative", "top": "45%"}
- * @since 1.2.0
- */
- labelStyle: {
- /**
- * @ignore
- */
- fontWeight: 'bold',
- /**
- * @ignore
- */
- position: 'relative',
- /**
- * @ignore
- */
- top: '45%'
- },
- /**
- * CSS styles for the loading screen that covers the plot area.
- *
- * In styled mode, the loading label is styled with the
- * `.highcharts-loading` class.
- *
- * @sample {highcharts|highmaps} highcharts/loading/style/
- * Gray plot area, white text
- * @sample {highstock} stock/loading/general/
- * Gray plot area, white text
- *
- * @type {Highcharts.CSSObject}
- * @default {"position": "absolute", "backgroundColor": "#ffffff", "opacity": 0.5, "textAlign": "center"}
- * @since 1.2.0
- */
- style: {
- /**
- * @ignore
- */
- position: 'absolute',
- /**
- * @ignore
- */
- backgroundColor: '#ffffff',
- /**
- * @ignore
- */
- opacity: 0.5,
- /**
- * @ignore
- */
- textAlign: 'center'
- }
- },
- /**
- * Options for the tooltip that appears when the user hovers over a
- * series or point.
- *
- * @declare Highcharts.TooltipOptions
- */
- tooltip: {
- /**
- * The color of the tooltip border. When `undefined`, the border takes
- * the color of the corresponding series or point.
- *
- * @sample {highcharts} highcharts/tooltip/bordercolor-default/
- * Follow series by default
- * @sample {highcharts} highcharts/tooltip/bordercolor-black/
- * Black border
- * @sample {highstock} stock/tooltip/general/
- * Styled tooltip
- * @sample {highmaps} maps/tooltip/background-border/
- * Background and border demo
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- * @apioption tooltip.borderColor
- */
- /**
- * A CSS class name to apply to the tooltip's container div,
- * allowing unique CSS styling for each chart.
- *
- * @type {string}
- * @apioption tooltip.className
- */
- /**
- * Since 4.1, the crosshair definitions are moved to the Axis object
- * in order for a better separation from the tooltip. See
- * [xAxis.crosshair](#xAxis.crosshair).
- *
- * @sample {highcharts} highcharts/tooltip/crosshairs-x/
- * Enable a crosshair for the x value
- *
- * @deprecated
- *
- * @type {*}
- * @default true
- * @apioption tooltip.crosshairs
- */
- /**
- * Distance from point to tooltip in pixels.
- *
- * @type {number}
- * @default 16
- * @apioption tooltip.distance
- */
- /**
- * Whether the tooltip should follow the mouse as it moves across
- * columns, pie slices and other point types with an extent.
- * By default it behaves this way for pie, polygon, map, sankey
- * and wordcloud series by override in the `plotOptions`
- * for those series types.
- *
- * For touch moves to behave the same way, [followTouchMove](
- * #tooltip.followTouchMove) must be `true` also.
- *
- * @type {boolean}
- * @default {highcharts} false
- * @default {highstock} false
- * @default {highmaps} true
- * @since 3.0
- * @apioption tooltip.followPointer
- */
- /**
- * Whether the tooltip should update as the finger moves on a touch
- * device. If this is `true` and [chart.panning](#chart.panning) is
- * set,`followTouchMove` will take over one-finger touches, so the user
- * needs to use two fingers for zooming and panning.
- *
- * Note the difference to [followPointer](#tooltip.followPointer) that
- * only defines the _position_ of the tooltip. If `followPointer` is
- * false in for example a column series, the tooltip will show above or
- * below the column, but as `followTouchMove` is true, the tooltip will
- * jump from column to column as the user swipes across the plot area.
- *
- * @type {boolean}
- * @default {highcharts} true
- * @default {highstock} true
- * @default {highmaps} false
- * @since 3.0.1
- * @apioption tooltip.followTouchMove
- */
- /**
- * Callback function to format the text of the tooltip from scratch. In
- * case of single or [shared](#tooltip.shared) tooltips, a string should
- * be returned. In case of [split](#tooltip.split) tooltips, it should
- * return an array where the first item is the header, and subsequent
- * items are mapped to the points. Return `false` to disable tooltip for
- * a specific point on series.
- *
- * A subset of HTML is supported. Unless `useHTML` is true, the HTML of
- * the tooltip is parsed and converted to SVG, therefore this isn't a
- * complete HTML renderer. The following HTML tags are supported: `b`,
- * `br`, `em`, `i`, `span`, `strong`. Spans can be styled with a `style`
- * attribute, but only text-related CSS, that is shared with SVG, is
- * handled.
- *
- * The available data in the formatter differ a bit depending on whether
- * the tooltip is shared or split, or belongs to a single point. In a
- * shared/split tooltip, all properties except `x`, which is common for
- * all points, are kept in an array, `this.points`.
- *
- * Available data are:
- *
- * - **this.percentage (not shared) /**
- * **this.points[i].percentage (shared)**:
- * Stacked series and pies only. The point's percentage of the total.
- *
- * - **this.point (not shared) / this.points[i].point (shared)**:
- * The point object. The point name, if defined, is available through
- * `this.point.name`.
- *
- * - **this.points**:
- * In a shared tooltip, this is an array containing all other
- * properties for each point.
- *
- * - **this.series (not shared) / this.points[i].series (shared)**:
- * The series object. The series name is available through
- * `this.series.name`.
- *
- * - **this.total (not shared) / this.points[i].total (shared)**:
- * Stacked series only. The total value at this point's x value.
- *
- * - **this.x**:
- * The x value. This property is the same regardless of the tooltip
- * being shared or not.
- *
- * - **this.y (not shared) / this.points[i].y (shared)**:
- * The y value.
- *
- * @sample {highcharts} highcharts/tooltip/formatter-simple/
- * Simple string formatting
- * @sample {highcharts} highcharts/tooltip/formatter-shared/
- * Formatting with shared tooltip
- * @sample {highcharts|highstock} highcharts/tooltip/formatter-split/
- * Formatting with split tooltip
- * @sample highcharts/tooltip/formatter-conditional-default/
- * Extending default formatter
- * @sample {highstock} stock/tooltip/formatter/
- * Formatting with shared tooltip
- * @sample {highmaps} maps/tooltip/formatter/
- * String formatting
- *
- * @type {Highcharts.TooltipFormatterCallbackFunction}
- * @apioption tooltip.formatter
- */
- /**
- * Callback function to format the text of the tooltip for
- * visible null points.
- * Works analogously to [formatter](#tooltip.formatter).
- *
- * @sample highcharts/plotoptions/series-nullformat
- * Format data label and tooltip for null point.
- *
- * @type {Highcharts.TooltipFormatterCallbackFunction}
- * @apioption tooltip.nullFormatter
- */
- /**
- * The number of milliseconds to wait until the tooltip is hidden when
- * mouse out from a point or chart.
- *
- * @type {number}
- * @default 500
- * @since 3.0
- * @apioption tooltip.hideDelay
- */
- /**
- * Whether to allow the tooltip to render outside the chart's SVG
- * element box. By default (`false`), the tooltip is rendered within the
- * chart's SVG element, which results in the tooltip being aligned
- * inside the chart area. For small charts, this may result in clipping
- * or overlapping. When `true`, a separate SVG element is created and
- * overlaid on the page, allowing the tooltip to be aligned inside the
- * page itself.
- *
- * Defaults to `true` if `chart.scrollablePlotArea` is activated,
- * otherwise `false`.
- *
- * @sample highcharts/tooltip/outside
- * Small charts with tooltips outside
- *
- * @type {boolean|undefined}
- * @default undefined
- * @since 6.1.1
- * @apioption tooltip.outside
- */
- /**
- * A callback function for formatting the HTML output for a single point
- * in the tooltip. Like the `pointFormat` string, but with more
- * flexibility.
- *
- * @type {Highcharts.FormatterCallbackFunction<Highcharts.Point>}
- * @since 4.1.0
- * @context Highcharts.Point
- * @apioption tooltip.pointFormatter
- */
- /**
- * A callback function to place the tooltip in a default position. The
- * callback receives three parameters: `labelWidth`, `labelHeight` and
- * `point`, where point contains values for `plotX` and `plotY` telling
- * where the reference point is in the plot area. Add `chart.plotLeft`
- * and `chart.plotTop` to get the full coordinates.
- *
- * Since v7, when [tooltip.split](#tooltip.split) option is enabled,
- * positioner is called for each of the boxes separately, including
- * xAxis header. xAxis header is not a point, instead `point` argument
- * contains info:
- * `{ plotX: Number, plotY: Number, isHeader: Boolean }`
- *
- *
- * The return should be an object containing x and y values, for example
- * `{ x: 100, y: 100 }`.
- *
- * @sample {highcharts} highcharts/tooltip/positioner/
- * A fixed tooltip position
- * @sample {highstock} stock/tooltip/positioner/
- * A fixed tooltip position on top of the chart
- * @sample {highmaps} maps/tooltip/positioner/
- * A fixed tooltip position
- * @sample {highstock} stock/tooltip/split-positioner/
- * Split tooltip with fixed positions
- * @sample {highstock} stock/tooltip/positioner-scrollable-plotarea/
- * Scrollable plot area combined with tooltip positioner
- *
- * @type {Highcharts.TooltipPositionerCallbackFunction}
- * @since 2.2.4
- * @apioption tooltip.positioner
- */
- /**
- * The name of a symbol to use for the border around the tooltip. Can
- * be one of: `"callout"`, `"circle"`, or `"square"`. When
- * [tooltip.split](#tooltip.split)
- * option is enabled, shape is applied to all boxes except header, which
- * is controlled by
- * [tooltip.headerShape](#tooltip.headerShape).
- *
- * Custom callbacks for symbol path generation can also be added to
- * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
- * [series.marker.symbol](plotOptions.line.marker.symbol).
- *
- * @type {Highcharts.TooltipShapeValue}
- * @default callout
- * @since 4.0
- * @apioption tooltip.shape
- */
- /**
- * The name of a symbol to use for the border around the tooltip
- * header. Applies only when [tooltip.split](#tooltip.split) is
- * enabled.
- *
- * Custom callbacks for symbol path generation can also be added to
- * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
- * [series.marker.symbol](plotOptions.line.marker.symbol).
- *
- * @see [tooltip.shape](#tooltip.shape)
- *
- * @sample {highstock} stock/tooltip/split-positioner/
- * Different shapes for header and split boxes
- *
- * @type {Highcharts.TooltipShapeValue}
- * @default callout
- * @validvalue ["callout", "square"]
- * @since 7.0
- * @apioption tooltip.headerShape
- */
- /**
- * When the tooltip is shared, the entire plot area will capture mouse
- * movement or touch events. Tooltip texts for series types with ordered
- * data (not pie, scatter, flags etc) will be shown in a single bubble.
- * This is recommended for single series charts and for tablet/mobile
- * optimized charts.
- *
- * See also [tooltip.split](#tooltip.split), that is better suited for
- * charts with many series, especially line-type series. The
- * `tooltip.split` option takes precedence over `tooltip.shared`.
- *
- * @sample {highcharts} highcharts/tooltip/shared-false/
- * False by default
- * @sample {highcharts} highcharts/tooltip/shared-true/
- * True
- * @sample {highcharts} highcharts/tooltip/shared-x-crosshair/
- * True with x axis crosshair
- * @sample {highcharts} highcharts/tooltip/shared-true-mixed-types/
- * True with mixed series types
- *
- * @type {boolean}
- * @default false
- * @since 2.1
- * @product highcharts highstock
- * @apioption tooltip.shared
- */
- /**
- * Split the tooltip into one label per series, with the header close
- * to the axis. This is recommended over [shared](#tooltip.shared)
- * tooltips for charts with multiple line series, generally making them
- * easier to read. This option takes precedence over `tooltip.shared`.
- *
- * @productdesc {highstock} In Highstock, tooltips are split by default
- * since v6.0.0. Stock charts typically contain multi-dimension points
- * and multiple panes, making split tooltips the preferred layout over
- * the previous `shared` tooltip.
- *
- * @sample highcharts/tooltip/split/
- * Split tooltip
- * @sample {highcharts|highstock} highcharts/tooltip/formatter-split/
- * Split tooltip and custom formatter callback
- *
- * @type {boolean}
- * @default {highcharts} false
- * @default {highstock} true
- * @since 5.0.0
- * @product highcharts highstock
- * @apioption tooltip.split
- */
- /**
- * Prevents the tooltip from switching or closing, when touched or
- * pointed.
- *
- * @sample highcharts/tooltip/stickoncontact/
- * Tooltip sticks on pointer contact
- *
- * @type {boolean}
- * @since 8.0.1
- * @apioption tooltip.stickOnContact
- */
- /**
- * Use HTML to render the contents of the tooltip instead of SVG. Using
- * HTML allows advanced formatting like tables and images in the
- * tooltip. It is also recommended for rtl languages as it works around
- * rtl bugs in early Firefox.
- *
- * @sample {highcharts|highstock} highcharts/tooltip/footerformat/
- * A table for value alignment
- * @sample {highcharts|highstock} highcharts/tooltip/fullhtml/
- * Full HTML tooltip
- * @sample {highmaps} maps/tooltip/usehtml/
- * Pure HTML tooltip
- *
- * @type {boolean}
- * @default false
- * @since 2.2
- * @apioption tooltip.useHTML
- */
- /**
- * How many decimals to show in each series' y value. This is
- * overridable in each series' tooltip options object. The default is to
- * preserve all decimals.
- *
- * @sample {highcharts|highstock} highcharts/tooltip/valuedecimals/
- * Set decimals, prefix and suffix for the value
- * @sample {highmaps} maps/tooltip/valuedecimals/
- * Set decimals, prefix and suffix for the value
- *
- * @type {number}
- * @since 2.2
- * @apioption tooltip.valueDecimals
- */
- /**
- * A string to prepend to each series' y value. Overridable in each
- * series' tooltip options object.
- *
- * @sample {highcharts|highstock} highcharts/tooltip/valuedecimals/
- * Set decimals, prefix and suffix for the value
- * @sample {highmaps} maps/tooltip/valuedecimals/
- * Set decimals, prefix and suffix for the value
- *
- * @type {string}
- * @since 2.2
- * @apioption tooltip.valuePrefix
- */
- /**
- * A string to append to each series' y value. Overridable in each
- * series' tooltip options object.
- *
- * @sample {highcharts|highstock} highcharts/tooltip/valuedecimals/
- * Set decimals, prefix and suffix for the value
- * @sample {highmaps} maps/tooltip/valuedecimals/
- * Set decimals, prefix and suffix for the value
- *
- * @type {string}
- * @since 2.2
- * @apioption tooltip.valueSuffix
- */
- /**
- * The format for the date in the tooltip header if the X axis is a
- * datetime axis. The default is a best guess based on the smallest
- * distance between points in the chart.
- *
- * @sample {highcharts} highcharts/tooltip/xdateformat/
- * A different format
- *
- * @type {string}
- * @product highcharts highstock gantt
- * @apioption tooltip.xDateFormat
- */
- /**
- * How many decimals to show for the `point.change` value when the
- * `series.compare` option is set. This is overridable in each series'
- * tooltip options object. The default is to preserve all decimals.
- *
- * @type {number}
- * @since 1.0.1
- * @product highstock
- * @apioption tooltip.changeDecimals
- */
- /**
- * Enable or disable the tooltip.
- *
- * @sample {highcharts} highcharts/tooltip/enabled/
- * Disabled
- * @sample {highcharts} highcharts/plotoptions/series-point-events-mouseover/
- * Disable tooltip and show values on chart instead
- */
- enabled: true,
- /**
- * Enable or disable animation of the tooltip.
- *
- * @type {boolean}
- * @default true
- * @since 2.3.0
- */
- animation: svg,
- /**
- * The radius of the rounded border corners.
- *
- * @sample {highcharts} highcharts/tooltip/bordercolor-default/
- * 5px by default
- * @sample {highcharts} highcharts/tooltip/borderradius-0/
- * Square borders
- * @sample {highmaps} maps/tooltip/background-border/
- * Background and border demo
- */
- borderRadius: 3,
- /**
- * For series on a datetime axes, the date format in the tooltip's
- * header will by default be guessed based on the closest data points.
- * This member gives the default string representations used for
- * each unit. For an overview of the replacement codes, see
- * [dateFormat](/class-reference/Highcharts#dateFormat).
- *
- * @see [xAxis.dateTimeLabelFormats](#xAxis.dateTimeLabelFormats)
- *
- * @type {Highcharts.Dictionary<string>}
- * @product highcharts highstock gantt
- */
- dateTimeLabelFormats: {
- /** @internal */
- millisecond: '%A, %b %e, %H:%M:%S.%L',
- /** @internal */
- second: '%A, %b %e, %H:%M:%S',
- /** @internal */
- minute: '%A, %b %e, %H:%M',
- /** @internal */
- hour: '%A, %b %e, %H:%M',
- /** @internal */
- day: '%A, %b %e, %Y',
- /** @internal */
- week: 'Week from %A, %b %e, %Y',
- /** @internal */
- month: '%B %Y',
- /** @internal */
- year: '%Y'
- },
- /**
- * A string to append to the tooltip format.
- *
- * @sample {highcharts} highcharts/tooltip/footerformat/
- * A table for value alignment
- * @sample {highmaps} maps/tooltip/format/
- * Format demo
- *
- * @since 2.2
- */
- footerFormat: '',
- /**
- * Padding inside the tooltip, in pixels.
- *
- * @since 5.0.0
- */
- padding: 8,
- /**
- * Proximity snap for graphs or single points. It defaults to 10 for
- * mouse-powered devices and 25 for touch devices.
- *
- * Note that in most cases the whole plot area captures the mouse
- * movement, and in these cases `tooltip.snap` doesn't make sense. This
- * applies when [stickyTracking](#plotOptions.series.stickyTracking)
- * is `true` (default) and when the tooltip is [shared](#tooltip.shared)
- * or [split](#tooltip.split).
- *
- * @sample {highcharts} highcharts/tooltip/bordercolor-default/
- * 10 px by default
- * @sample {highcharts} highcharts/tooltip/snap-50/
- * 50 px on graph
- *
- * @type {number}
- * @default 10/25
- * @since 1.2.0
- * @product highcharts highstock
- */
- snap: isTouchDevice ? 25 : 10,
- /**
- * The HTML of the tooltip header line. Variables are enclosed by
- * curly brackets. Available variables are `point.key`, `series.name`,
- * `series.color` and other members from the `point` and `series`
- * objects. The `point.key` variable contains the category name, x
- * value or datetime string depending on the type of axis. For datetime
- * axes, the `point.key` date format can be set using
- * `tooltip.xDateFormat`.
- *
- * @sample {highcharts} highcharts/tooltip/footerformat/
- * An HTML table in the tooltip
- * @sample {highstock} highcharts/tooltip/footerformat/
- * An HTML table in the tooltip
- * @sample {highmaps} maps/tooltip/format/
- * Format demo
- *
- * @type {string}
- * @apioption tooltip.headerFormat
- */
- headerFormat: '<span style="font-size: 10px">{point.key}</span><br/>',
- /**
- * The HTML of the null point's line in the tooltip. Works analogously
- * to [pointFormat](#tooltip.pointFormat).
- *
- * @sample {highcharts} highcharts/plotoptions/series-nullformat
- * Format data label and tooltip for null point.
- *
- * @type {string}
- * @apioption tooltip.nullFormat
- */
- /**
- * The HTML of the point's line in the tooltip. Variables are enclosed
- * by curly brackets. Available variables are point.x, point.y, series.
- * name and series.color and other properties on the same form.
- * Furthermore, `point.y` can be extended by the `tooltip.valuePrefix`
- * and `tooltip.valueSuffix` variables. This can also be overridden for
- * each series, which makes it a good hook for displaying units.
- *
- * In styled mode, the dot is colored by a class name rather
- * than the point color.
- *
- * @sample {highcharts} highcharts/tooltip/pointformat/
- * A different point format with value suffix
- * @sample {highmaps} maps/tooltip/format/
- * Format demo
- *
- * @type {string}
- * @since 2.2
- * @apioption tooltip.pointFormat
- */
- pointFormat: '<span style="color:{point.color}">\u25CF</span> {series.name}: <b>{point.y}</b><br/>',
- /**
- * The background color or gradient for the tooltip.
- *
- * In styled mode, the stroke width is set in the
- * `.highcharts-tooltip-box` class.
- *
- * @sample {highcharts} highcharts/tooltip/backgroundcolor-solid/
- * Yellowish background
- * @sample {highcharts} highcharts/tooltip/backgroundcolor-gradient/
- * Gradient
- * @sample {highcharts} highcharts/css/tooltip-border-background/
- * Tooltip in styled mode
- * @sample {highstock} stock/tooltip/general/
- * Custom tooltip
- * @sample {highstock} highcharts/css/tooltip-border-background/
- * Tooltip in styled mode
- * @sample {highmaps} maps/tooltip/background-border/
- * Background and border demo
- * @sample {highmaps} highcharts/css/tooltip-border-background/
- * Tooltip in styled mode
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- */
- backgroundColor: color('#f7f7f7')
- .setOpacity(0.85).get(),
- /**
- * The pixel width of the tooltip border.
- *
- * In styled mode, the stroke width is set in the
- * `.highcharts-tooltip-box` class.
- *
- * @sample {highcharts} highcharts/tooltip/bordercolor-default/
- * 2px by default
- * @sample {highcharts} highcharts/tooltip/borderwidth/
- * No border (shadow only)
- * @sample {highcharts} highcharts/css/tooltip-border-background/
- * Tooltip in styled mode
- * @sample {highstock} stock/tooltip/general/
- * Custom tooltip
- * @sample {highstock} highcharts/css/tooltip-border-background/
- * Tooltip in styled mode
- * @sample {highmaps} maps/tooltip/background-border/
- * Background and border demo
- * @sample {highmaps} highcharts/css/tooltip-border-background/
- * Tooltip in styled mode
- */
- borderWidth: 1,
- /**
- * Whether to apply a drop shadow to the tooltip.
- *
- * @sample {highcharts} highcharts/tooltip/bordercolor-default/
- * True by default
- * @sample {highcharts} highcharts/tooltip/shadow/
- * False
- * @sample {highmaps} maps/tooltip/positioner/
- * Fixed tooltip position, border and shadow disabled
- *
- * @type {boolean|Highcharts.ShadowOptionsObject}
- */
- shadow: true,
- /**
- * CSS styles for the tooltip. The tooltip can also be styled through
- * the CSS class `.highcharts-tooltip`.
- *
- * Note that the default `pointerEvents` style makes the tooltip ignore
- * mouse events, so in order to use clickable tooltips, this value must
- * be set to `auto`.
- *
- * @sample {highcharts} highcharts/tooltip/style/
- * Greater padding, bold text
- *
- * @type {Highcharts.CSSObject}
- */
- style: {
- /** @internal */
- color: '#333333',
- /** @internal */
- cursor: 'default',
- /** @internal */
- fontSize: '12px',
- /** @internal */
- whiteSpace: 'nowrap'
- }
- },
- /**
- * Highchart by default puts a credits label in the lower right corner
- * of the chart. This can be changed using these options.
- */
- credits: {
- /**
- * Credits for map source to be concatenated with conventional credit
- * text. By default this is a format string that collects copyright
- * information from the map if available.
- *
- * @see [mapTextFull](#credits.mapTextFull)
- * @see [text](#credits.text)
- *
- * @type {string}
- * @default \u00a9 <a href="{geojson.copyrightUrl}">{geojson.copyrightShort}</a>
- * @since 4.2.2
- * @product highmaps
- * @apioption credits.mapText
- */
- /**
- * Detailed credits for map source to be displayed on hover of credits
- * text. By default this is a format string that collects copyright
- * information from the map if available.
- *
- * @see [mapText](#credits.mapText)
- * @see [text](#credits.text)
- *
- * @type {string}
- * @default {geojson.copyright}
- * @since 4.2.2
- * @product highmaps
- * @apioption credits.mapTextFull
- */
- /**
- * Whether to show the credits text.
- *
- * @sample {highcharts} highcharts/credits/enabled-false/
- * Credits disabled
- * @sample {highstock} stock/credits/enabled/
- * Credits disabled
- * @sample {highmaps} maps/credits/enabled-false/
- * Credits disabled
- */
- enabled: true,
- /**
- * The URL for the credits label.
- *
- * @sample {highcharts} highcharts/credits/href/
- * Custom URL and text
- * @sample {highmaps} maps/credits/customized/
- * Custom URL and text
- */
- href: 'https://www.highcharts.com?credits',
- /**
- * Position configuration for the credits label.
- *
- * @sample {highcharts} highcharts/credits/position-left/
- * Left aligned
- * @sample {highcharts} highcharts/credits/position-left/
- * Left aligned
- * @sample {highmaps} maps/credits/customized/
- * Left aligned
- * @sample {highmaps} maps/credits/customized/
- * Left aligned
- *
- * @type {Highcharts.AlignObject}
- * @since 2.1
- */
- position: {
- /** @internal */
- align: 'right',
- /** @internal */
- x: -10,
- /** @internal */
- verticalAlign: 'bottom',
- /** @internal */
- y: -5
- },
- /**
- * CSS styles for the credits label.
- *
- * @see In styled mode, credits styles can be set with the
- * `.highcharts-credits` class.
- *
- * @type {Highcharts.CSSObject}
- */
- style: {
- /** @internal */
- cursor: 'pointer',
- /** @internal */
- color: '#999999',
- /** @internal */
- fontSize: '9px'
- },
- /**
- * The text for the credits label.
- *
- * @productdesc {highmaps}
- * If a map is loaded as GeoJSON, the text defaults to
- * `Highcharts @ {map-credits}`. Otherwise, it defaults to
- * `Highcharts.com`.
- *
- * @sample {highcharts} highcharts/credits/href/
- * Custom URL and text
- * @sample {highmaps} maps/credits/customized/
- * Custom URL and text
- */
- text: 'Highcharts.com'
- }
- };
- /* eslint-disable spaced-comment */
- '';
- /**
- * Global `Time` object with default options. Since v6.0.5, time settings can be
- * applied individually for each chart. If no individual settings apply, this
- * `Time` object is shared by all instances.
- *
- * @name Highcharts.time
- * @type {Highcharts.Time}
- */
- H.time = new Time(merge(H.defaultOptions.global, H.defaultOptions.time));
- /**
- * Formats a JavaScript date timestamp (milliseconds since Jan 1st 1970) into a
- * human readable date string. The format is a subset of the formats for PHP's
- * [strftime](https://www.php.net/manual/en/function.strftime.php) function.
- * Additional formats can be given in the {@link Highcharts.dateFormats} hook.
- *
- * Since v6.0.5, all internal dates are formatted through the
- * {@link Highcharts.Chart#time} instance to respect chart-level time settings.
- * The `Highcharts.dateFormat` function only reflects global time settings set
- * with `setOptions`.
- *
- * Supported format keys:
- * - `%a`: Short weekday, like 'Mon'
- * - `%A`: Long weekday, like 'Monday'
- * - `%d`: Two digit day of the month, 01 to 31
- * - `%e`: Day of the month, 1 through 31
- * - `%w`: Day of the week, 0 through 6
- * - `%b`: Short month, like 'Jan'
- * - `%B`: Long month, like 'January'
- * - `%m`: Two digit month number, 01 through 12
- * - `%y`: Two digits year, like 09 for 2009
- * - `%Y`: Four digits year, like 2009
- * - `%H`: Two digits hours in 24h format, 00 through 23
- * - `%k`: Hours in 24h format, 0 through 23
- * - `%I`: Two digits hours in 12h format, 00 through 11
- * - `%l`: Hours in 12h format, 1 through 12
- * - `%M`: Two digits minutes, 00 through 59
- * - `%p`: Upper case AM or PM
- * - `%P`: Lower case AM or PM
- * - `%S`: Two digits seconds, 00 through 59
- * - `%L`: Milliseconds (naming from Ruby)
- *
- * @function Highcharts.dateFormat
- *
- * @param {string} format
- * The desired format where various time representations are prefixed
- * with `%`.
- *
- * @param {number} timestamp
- * The JavaScript timestamp.
- *
- * @param {boolean} [capitalize=false]
- * Upper case first letter in the return.
- *
- * @return {string}
- * The formatted date.
- */
- H.dateFormat = function (format, timestamp, capitalize) {
- return H.time.dateFormat(format, timestamp, capitalize);
- };
- var optionsModule = {
- dateFormat: H.dateFormat,
- defaultOptions: H.defaultOptions,
- time: H.time
- };
- export default optionsModule;
|